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


Ignore:
Timestamp:
May 30, 2016 7:16:50 AM (4 years ago)
Author:
wojciech
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • DevNotes/DevGuide/CodingRules

    v5 v6  
    5656Naming 
    5757 
    58     Use CamelCase for class names 
    59     Use box_car with underscores separating words for variable and method names. 
    60     Use box_car with underscores for namespaces & directories 
    61     Use _box_car with a leading underscore for non-public methods and _CamelCase with a leading underscore for non-public classes. 
    62     Never use __box_car__ with leading and trailing double underscores 
    63     Avoid one-letter variable names. 
    64  
    65     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) 
    66     Models: Don't add/Remove “model” in/from the name (i.e. barbell not BarBellModel) 
    67     Models: When defining parameters use radius_core, sld_core names not core_radius and core_sld 
     58    * Use CamelCase for class names 
     59    * Use box_car with underscores separating words for variable and method names. 
     60    * Use box_car with underscores for namespaces & directories 
     61    * Use _box_car with a leading underscore for non-public methods and _CamelCase with a leading underscore for non-public classes. 
     62    * Never use __box_car__ with leading and trailing double underscores 
     63    * Avoid one-letter variable names. 
     64 
     65    * 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) 
     66    * Models: Don't add/Remove “model” in/from the name (i.e. barbell not BarBellModel) 
     67    * Models: When defining parameters use radius_core, sld_core names not core_radius and core_sld 
    6868 
    6969Imports