Changes between Version 6 and Version 7 of code/C++_styleguide

Timestamp:

Oct 31, 2007, 10:24:50 AM (16 years ago)

Author:

patrick

Comment:

—

code/C++_styleguide

@@ -182 +182 @@
 
 
+=== Constants ===
+The use of magic numbers in the code should be avoided. Numbers other than 0 and 1 should be considered declared as named constants instead.
+
+
+== Statements ==
+
+
+=== Access Modifiers for Classes ===
+The parts of a class must be sorted public, protected and private. All sections must be identified explicitly. Not applicable sections should be left out.
+
+
+=== Type Casts ===
+Type conversions must always be done explicitly. Never rely on implicit type conversion.
+{{{
+floatValue = static_cast<float>(intValue); // NOT: floatValue = intValue;
+// or:
+floatValue = float(intValue);
+}}}
+By this, the programmer indicates that he is aware of the different types involved and that the mix is intentional.
+
+
+=== Encapsulation ===
+Class variables should never be declared public. The concept of C++ information hiding and encapsulation is violated by public variables. Use private variables and access functions instead. One exception to this rule is when the class is essentially a data structure, with no behavior (equivalent to a C struct). In this case it is appropriate to make the class' instance variables public.
+
+
+=== Loops ===
+Only loop control statements must be included in the for() construction.
+
+
+== Layout ==
+=== Indentation ===
+Basic indentation should be 2.
+{{{
+for (i = 0; i < numberOfElements; i++) 
+  a[i] = 0;
+}}}
+
+
+=== Block Layout ===
+Block layout should be as illustrated in this example:
+{{{
+while (!done) {
+  doSomething();
+  done = moreToDo();
+}
+}}}
+
+=== Class Declaration ===
+The class declarations should have the following form:
+{{{
+class SomeClass : public BaseClass 
+{ 
+public: 
+  void functionBla();
+
+protected:
+  ...
+
+private:
+  ...
+};
+}}}
+
+
+=== Function Definitions ===
+Method definitions should have the following form:
+{{{
+void functionBla()
+{
+  ...
+}
+}}}
+
+=== If-Statement ===
+The if-else class of statements should have the following form:
+{{{
+if (condition) {
+  ...
+}
+else {
+  ...
+}
+}}}
+
 == Special Implementations ==
 === Use STL Libraries ===