diff options
| author | Beman Dawes <bdawes@acm.org> | 2003-02-26 19:56:52 +0000 |
|---|---|---|
| committer | Beman Dawes <bdawes@acm.org> | 2003-02-26 19:56:52 +0000 |
| commit | c458eb0a3fbb5c76a5fb3673aee0cd21188e8aef (patch) | |
| tree | ad9380288f8273a395e2e61fed4a57ad2398355e /more/lib_guide.htm | |
| parent | 71f683395d77cb4ad1702d7be7379e886ae0f7fc (diff) | |
| download | boost-c458eb0a3fbb5c76a5fb3673aee0cd21188e8aef.tar.gz | |
clarify naming conventions
[SVN r17662]
Diffstat (limited to 'more/lib_guide.htm')
| -rw-r--r-- | more/lib_guide.htm | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/more/lib_guide.htm b/more/lib_guide.htm index cb710bc84e..416ffca641 100644 --- a/more/lib_guide.htm +++ b/more/lib_guide.htm @@ -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. 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> + <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. 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> |