home.md

+1. namespace component (``NAME``)
+    * description: simple lower case name which if in two parts means ``organization::component``
+    * regex: ``^[a-z]{3,10}$``, !``detail``,!``tst``,!``example``
+    * eg: ``scale``, ``origen``, ``polaris``, ``nemesis``
+    * special:
+        * use ``detail`` for implementation details
+        * use ``tst`` for unit tests (possibly not pretty)
+        * use ``example`` for an example usage (should be pretty)
+2.  fully qualified namespace (``NAMESPACE``)
+    * regex: ``NAME(::NAME)?(::detail|::tst|::example)?``
+    * e.g. ``scale::io``,``origen::detail``,`` origen::tst``,``origen::example``,``ornl::gtest::example``
+3. class name (``CLASS``)
+    * description: standard CamelCase used for most classes, avoid abbreviations, for acronyms capitalize first, e.g. ORIGEN-->Origen or IO-->Io, MG-->Mg, CE-->Ce
+    * regex: ``([A-Z][a-z]*)+``
+    * e.g. ``NuclideSet``, ``Nexus``, ``LibraryIo``, ``CeResourceFile``
+4. typedef or variant class name (``VARCLASS``)
+    * description: CamelCase_variant used for classes which are logically very similar, perhaps typedefed templated classes
+    * regex: ``CLASS_.+``
+    * conventions: for STL typedefs, use ``Vec`` for vector, ``Map`` for map, ``Set`` for set, ``Dbl`` for double, ``Int`` for int, ``Str`` for string, ``Long`` for long (>=64-bit), ``Sze`` for size_t, ``Bool`` for bool.
+    * e.g.: ``LibraryIo_bof``, ``LibraryIo_s61``, ``Vec_Dbl``, ``Vec_Str``
+5. specific-use free functions (``SPECFUNC``)
+    * description: functions not bound to any particular class use lazyCamelCase (does not include static functions)
+    * regex: ``[a-z]+[A-Z]*``
+    * conventions: try to use a verb as the first word, e.g. countListElements instead of listElementCount
+6. general-use free functions (``GENFUNC``)
+    * description: in style of the STL library, must be templated
+    * regex: ``[a-z]+(_[a-z]+)*`` (snake_case)
+7. class methods (``METHOD``)
+    * description: use underscores and all lower case
+    * regex: ``[a-z]+(_[a-z]+)*``
+    * convention: accessor method "getters" have form ``Var var() const`` while "setters" have ``void set_var(Var)``.
+8. variables (``VAR``)
+    * description: use underscores and all lower case
+    * regex: ``[a-z]+(_[a-z]+)*`` (snake_case)
+9. class member variables (``CLASSVAR``)
+    * description: use a prefix ``b_`` for the base class and ``d_`` for the derived class
+    * regex: ``[bd]_[a-z]+(_[a-z]+)*`` (snake_case)
+
+
 [Build Instructions](Build-instructions)
 
 [Vision Documents](Vision-documents)