boost/more
1
0
Fork 0
mirror of https://github.com/boostorg/more.git synced 2024-12-27 23:40:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

clarify naming conventions

Browse Source 
[SVN r17662]
This commit is contained in:
Beman Dawes 2003-02-26 19:56:52 +00:00
parent cbf7c8b59e
commit 23a33ee64e
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
lib_guide.htm
View File

@ -171,11 +171,16 @@ library, but a reasonable effort to comply is expected.</p>
supply performance, platform, or other implementation variations.</li>
</ul>
<ul>
<li>Use the lowercase/underscore <a href="#Naming">naming conventions</a> of
the C++ standard library.&nbsp; Template parameter names begin with an
uppercase letter. Macro (gasp!) names should be all uppercase and begin with
BOOST_. Acronyms should be treated as ordinary words
(e.g. <code>xml_parser</code> instead of <code>XML_parser</code>). </li>
<li>Use the naming conventions of the C++ Standard Library (See
<a href="#Naming">Naming conventions rationale</a>): <br>
&nbsp;<ul>
<li>Names (except as noted below) should be all lowercase, with words
separated by underscores.</li>
<li>Acronyms should be treated as ordinary names (e.g. <code>xml_parser</code> instead of <code>XML_parser</code>).</li>
<li>Template parameter names begin with an uppercase letter.</li>
<li>Macro (gasp!) names all uppercase and begin with BOOST_.</li>
</ul>
</li>
</ul>
<ul>
<li>Choose meaningful names - explicit is better than implicit, and readability counts.
@ -444,7 +449,7 @@ suggestion.&nbsp; Major contributions are usually acknowledged in the
documentation, while minor fixes are often mentioned in comments within the code
itself.</p>
<hr>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->20 February, 2003<!--webbot bot="Timestamp" endspan i-checksum="40398" --></p>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->26 February, 2003<!--webbot bot="Timestamp" endspan i-checksum="40410" --></p>
</body>