Changes between Version 2 and Version 3 of coding_rules

Timestamp:

01/10/11 10:34:06 (15 years ago)

Author:

Mathieu Morlighem

Comment:

more guidelines

coding_rules

@@ -1 +1 @@
 
-== Variable Names ==
+== General guidelines ==
+
+ - comment your code extensively (everybody must understand what is being done)
+ - NEVER more than one blank line please!
+
+== C/C++ ==
+
+ - if/for should follow this:
+{{{
+#!c
+for(int i=0<i<n;i++)  A[i]=i;
+
+if(a==0) bool=true;
+
+if(a==0){
+    output=true;
+    c=b
+}
+else{
+    output=false
+    c=a;
+}
+
+for(int i=0<i<n;i++){
+   A[i]=B[i];
+   B[i]=0;
+}
+}}}
+
+== Matlab ==
+
+- All matlab routines should start with a help (Example and See Also are not mandatory):
+{{{
+#!m
+function outputs=FunctionName(inputs)
+%FUNCTIONNAME - one line description
+%
+%   Extensive description of what is being done, inputs
+%   outputs, etc...
+%
+%   Usage:
+%      outputs=FunctionName(inputs)
+%
+%   Example:
+%      md.test=FunctionName(1);
+%
+%   See Also:
+%      FunctionName2, FunctionName3, ...
+}}}
+
+== Variable/Enum/Functions 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.
@@ -13 +61 @@
 }}}
 
-== Function/Modules Names ==
-
-Functions that return an output corresponding to a given input should be named as follows:
+ - Functions that return an output corresponding to a given input should be named as follows:
    - EnumToString
    - IdToName