[Avida-SVN] r2395 - development/documentation

[brysonda at myxo.css.msu.edu]

Author: brysonda
Date: 2008-02-28 16:05:26 -0500 (Thu, 28 Feb 2008)
New Revision: 2395

Modified:
   development/documentation/code_standards.html
Log:
Update coding standards to specifically mention class dependency guidelines.

Modified: development/documentation/code_standards.html
===================================================================
--- development/documentation/code_standards.html	2008-02-28 19:12:22 UTC (rev 2394)
+++ development/documentation/code_standards.html	2008-02-28 21:05:26 UTC (rev 2395)
@@ -281,6 +281,34 @@
 </ul>
 
 
+<p>&nbsp;</p>
+<h2>Class Dependency Guidelines</h2>
+<div style="margin-left: 10px">
+  <p>
+  Some groupings of classes should maintain important limitations with respect
+  to class dependency.
+  </p>
+
+  <h3>Tools Classes</h3>
+  <div style="margin-left: 10px">
+    <p>
+    All classes developed as general utility classes should be placed within the
+    <kbd style="color: #008844">source/tools</kbd> directory.   These classes
+    should have no dependencies that extend outside of this directory.
+    </p>
+  </div>
+
+  <h3>STL Usage</h3>
+  <div style="margin-left: 10px">
+    <p>
+    Usage of the Standard Template Library should be very limited.  A number of
+    these templates have unspecified orderings that can vary across platforms,
+    affecting consistency.  Where possible, it is greatly preferred to use the
+    local tools classes.
+    </p>
+  </div>
+</div>
+
 <hr />
 <p><a href="index.html">Return to the Index</a></p>