[Avida-SVN] r3045 - development/documentation

brysonda at myxo.css.msu.edu brysonda at myxo.css.msu.edu
Mon Dec 15 07:49:26 PST 2008


Author: brysonda
Date: 2008-12-15 10:49:26 -0500 (Mon, 15 Dec 2008)
New Revision: 3045

Modified:
   development/documentation/code_standards.html
Log:
Add more information to the coding standards file detailing the difference between public class/struct methods versus private and protected methods.

Modified: development/documentation/code_standards.html
===================================================================
--- development/documentation/code_standards.html	2008-12-15 15:41:12 UTC (rev 3044)
+++ development/documentation/code_standards.html	2008-12-15 15:49:26 UTC (rev 3045)
@@ -233,16 +233,26 @@
 </pre>
 </li>
 <li>
-  All functions should begin with a capital letter followed by lowercase. 
-  Additional words should be signified by capital letters.  Underscores 
-  should only be used to indicate a category of functions.  Examples:
+  All functions and public struct/class methods should begin with a capital
+  letter followed by lowercase.  Additional words should be signified by
+  capital letters.  Underscores should only be used to indicate a category
+  of functions.  Examples:
 <pre>
 Sort() 
 ThisIsMyFunction() 
-Inst_Divide()
+cHardwareCPU::Inst_Divide()
 </pre>
 </li>
 <li>
+  Private and protected struct/class support methods should begin with a
+  lowercase letter. Additional words should be signified by capital letters.
+  Underscores should only be used to indicate a category of functions.  Examples:
+<pre>
+cHardwareBase::doSlipMuation()
+cParser::parseCodeBlock()
+</pre>
+</li>
+<li>
   All class names should begin with a lowercase 'c', followed by capital 
   letters leading each word (similar to functions).  Templates have the same 
   pattern, but beginning with a 't', and enumeration types begin with an 




More information about the Avida-cvs mailing list