Changes between Version 1 and Version 2 of coding_rules

Timestamp:

08/09/10 15:13:13 (15 years ago)

Author:

Mathieu Morlighem

Comment:

added comments

coding_rules

@@ -1 +1 @@
 
-== Coding rules ==
+== Variable Names ==
 
  - variables should not use capital letters. Use underscores to make variables more understandable.
+
+== Enum Names ==
+
  - Function names and enums should not use any underscore. Use capital letters to make names more understandable.
 Example:
@@ -9 +12 @@
   Input* vx_input=GetInput(inputs,VxInput);
 }}}
+
+== Function/Modules Names ==
+
+Functions that return an output corresponding to a given input should be named as follows:
+   - EnumToString
+   - IdToName
+Never ever Id2Name or IdAsName,...
+If necessary, "From" can be used instead of "To" if emphasis has to be put on the input:
+   - ResultFromInputs