Changes between Version 13 and Version 14 of CodingRules

Timestamp:

11/26/13 15:49:11 (12 years ago)

Author:

tbretz

Comment:

--

CodingRules

@@ -27 +27 @@
 0. Use gRandom and do not define your own TRandom object. The global scope will take care of that. A major advantage of simulations is to be able to set a global(!) seed.
 0. For proper documentation, please have a look at other classes. Note that FACT++ and Mars style is slightly different. Mars is using THtml with some Mars specific setup, FACT++ is using doxygen.
-0. Never define constants as preprocessor directives. Generally avoid preprocessor directives.
+0. Never define constants as preprocessor directives. Generally avoid preprocessor directives. If you really need them use upper case only.
 o. omit else in constructions like *if (...) return x; [else] ....*
 0. Source files have the extension cc, header files the extension h, C source files just c.
@@ -40 +40 @@
 0. Do **never** use global variables, except you have discussed that with everybody else before.
 0. Try to avoid static variables (only use them if it is really unavoidable -- think twice)
+0. directory names should be lower case only (to easy distinguishable from source code files)
+0. typedefs should end with a _t like UInt_t
+