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

Timestamp:

Oct 30, 2007, 4:45:19 PM (16 years ago)

Author:

patrick

Comment:

—

code/C++_styleguide

@@ -29 +29 @@
 File content must be kept within 80 columns. 
 ''Comment: 80 columns is a common dimension for editors, terminal emulators, printers and debuggers, and files that are shared between several people should keep within these constraints. It improves readability when unintentional line breaks are avoided when passing a file between programmers.''
+
+=== Include Guard ===
+Header files must contain an include guard.
+{{{
+#ifndef MODULE_CLASSNAME_H 
+#define MODULE_CLASSNAME_H
+
+
+#endif /* MODULE_CLASSNAME_H */
+}}}
 
 == Comments ==
@@ -77 +87 @@
 ''Comment: Apart from its name and its type, the scope of a variable is its most important feature. Indicating class scope by using underscore makes it easy to distinguish class variables from local scratch variables. This is important because class variables are considered to have higher significance than method variables, and should be treated with special care by the programmer.''
 
-=== Constants ==
+=== Constants ===
 Named constants (including enumeration values) must be all uppercase using underscore to separate words. Always use constants instead of numbers. 
 {{{
@@ -134 +144 @@
 }}}
 
+
 == Indentation ==
 === Spaces ===
 Use 2 spaces for an indentation level. Never use tabs, as it is common in windows IDEs.
 
+=== Split Lines ===
+The incompleteness of split lines must be made obvious:
+{{{
+totalSum = a + b + c + 
+           d + e; 
+function(param1, param2, 
+         param3); 
+
+setText("Long line split" 
+        "into two parts."); 
+
+for (int tableNo = 0; tableNo < nTables; 
+     tableNo += tableStep) { ... }
+}}}
 
 == Whitespaces ==
@@ -143 +168 @@
 
 
-
-
-
+=== Include Statements ===
+Include statements should be sorted and grouped. Sorted by their hierarchical position in the system with low level files included first. Leave an empty line between groups of include statements.
+{{{
+#include <fstream> 
+#include <iomanip> 
+
+#include <qt/qbutton.h> 
+#include <qt/qtextfield.h> 
+
+#include "com/company/ui/PropertiesDialog.h" 
+#include "com/company/ui/MainWindow.h"
+}}}