Changes between Version 7 and Version 8 of CodingRules

Timestamp:

11/26/13 15:34:36 (11 years ago)

Author:

tbretz

Comment:

--

CodingRules

@@ -28 +28 @@
 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.
+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.
+0. Operators +=, -=, etc. are preferable over constructions like x=x+, x=x-, ...
+0. If you omit intentionally a break in a switch statement (*fallthru*) add a comment
+0. Sometimes including system headers is not identical for all operating systems, comments might help
+0. Try to avoid using dynamic allocation whenever possible: "int i=5; /* do something with i*/; /* i runs out of scope */" is preferred over "int *i = new int; *i=5; /* do something with i */; delete i;" Although this example sounds ridiculous, the same is true for every class instance you use.
 
 == Example ==
 {{{#!C++
+#ifndef MARS_Complex
+#define MARS_Complex
+
+#include <math.h> // needed for sqrt on Ubuntu 10.14
+
+class Complex
+{
+private:
+    double fRe;
+    double fIm;
+
+public:
+    Complex(double re, double im)
+        : fRe(re), fIm(im)
+    {
+    }
+    
+    double Modulus() const
+    {
+        return sqrt(fRE * fRe + fIm * fIm);
+    }
+
+    bool Foo(int a, int b)
+    {
+        for (int i=0; i<b-a; i++)
+        {
+            if (i<b)
+                bar(i);
+            else
+            {
+                bar(i);
+                bar(b);
+            }
+        }
+
+        const int c = a + b;
+        switch (c)
+        { 
+        case 0:
+           // Code goes here
+           return false;
+        case 1:
+        case 2:
+           // Code goes here
+           return false;
+        default:
+           // Code goes here
+           return true;
+        }
+
+        return true;
+     }
+};
+
+#endif 
 }}}