Changes between Version 5 and Version 6 of DevNotes/DevGuide/CodingRules

Timestamp:

May 30, 2016 7:16:50 AM (8 years ago)

Author:

wojciech

Comment:

—

DevNotes/DevGuide/CodingRules

@@ -56 +56 @@
 Naming
 
-    Use CamelCase for class names
-    Use box_car with underscores separating words for variable and method names.
-    Use box_car with underscores for namespaces & directories
-    Use _box_car with a leading underscore for non-public methods and _CamelCase with a leading underscore for non-public classes.
-    Never use __box_car__ with leading and trailing double underscores
-    Avoid one-letter variable names.
-
-    Models: for adding a new model no capitalization and thus no CamelCase in model names. If necessary use underscore to separate (i.e. barbell not BarBell or broad_peak not BroadPeak)
-    Models: Don't add/Remove “model” in/from the name (i.e. barbell not BarBellModel)
-    Models: When defining parameters use radius_core, sld_core names not core_radius and core_sld
+    * Use CamelCase for class names
+    * Use box_car with underscores separating words for variable and method names.
+    * Use box_car with underscores for namespaces & directories
+    * Use _box_car with a leading underscore for non-public methods and _CamelCase with a leading underscore for non-public classes.
+    * Never use __box_car__ with leading and trailing double underscores
+    * Avoid one-letter variable names.
+
+    * Models: for adding a new model no capitalization and thus no CamelCase in model names. If necessary use underscore to separate (i.e. barbell not BarBell or broad_peak not BroadPeak)
+    * Models: Don't add/Remove “model” in/from the name (i.e. barbell not BarBellModel)
+    * Models: When defining parameters use radius_core, sld_core names not core_radius and core_sld
 
 Imports