|
|
@@ -120,14 +120,20 @@ library, but a reasonable effort to comply is expected.</p>
|
|
|
<li>Headers should be good neighbors. See the <a href="header.htm">header
|
|
|
policy</a>.</li>
|
|
|
</ul>
|
|
|
-<ul>
|
|
|
- <li>Follow the <a href="imp_vars.htm">implementation variation policy</a>. </li>
|
|
|
-</ul>
|
|
|
<ul>
|
|
|
<li>Follow quality programming practices. See, for example, "Effective
|
|
|
C++" 2nd Edition, and "More Effective C++", both by Scott
|
|
|
Meyers, published by Addison Wesley.</li>
|
|
|
</ul>
|
|
|
+<ul>
|
|
|
+ <li>Use the C++ Standard Library or other Boost libraries, but only when the
|
|
|
+ benefits outweigh the costs. Do not use libraries other than the C++
|
|
|
+ Standard Library or Boost. See <a href="library_reuse.htm">Library reuse</a>.</li>
|
|
|
+</ul>
|
|
|
+<ul>
|
|
|
+ <li>Read <a href="imp_vars.htm">Implementation Variation</a> to see how to
|
|
|
+ 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
|
|
|
@@ -158,6 +164,19 @@ library, but a reasonable effort to comply is expected.</p>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
+<ul>
|
|
|
+ <li>Begin all source files with:
|
|
|
+ <ul>
|
|
|
+ <li>A comment line describing the contents of the file.</li>
|
|
|
+ <li>Comments describing copyright and licensing.</li>
|
|
|
+ <li>A comment line referencing the Boost home page in the form:<br>
|
|
|
+ <code>// See http://www.boost.org for updates, documentation, and
|
|
|
+ revision history.</code><br>
|
|
|
+ [Including revision history in source files is no longer recommended;
|
|
|
+ the publicly available CVS repository better serves that purpose.]</li>
|
|
|
+ </ul>
|
|
|
+ </li>
|
|
|
+</ul>
|
|
|
<h3>Documentation</h3>
|
|
|
<p>Even the simplest library needs some documentation; the amount should be
|
|
|
proportional to the need. The documentation should assume the readers have
|
|
|
@@ -261,7 +280,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 -->24 July, 2000<!--webbot bot="Timestamp" endspan i-checksum="21054" --></p>
|
|
|
+<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->30 August, 2000<!--webbot bot="Timestamp" endspan i-checksum="34279" --></p>
|
|
|
|
|
|
</body>
|
|
|
|
Beman Dawes