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

Timestamp:

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

Author:

patrick

Comment:

—

code/C++_styleguide

@@ -8 +8 @@
 Remember that any violation to the guide of course is allowed if it enhances readability.
 
-== File Organization ==
+== Files ==
 === Header and Source ===
 Keep your classes/files short, don't exceed 2000 LOC (if it get's longer you may separate functions into different modules). Put every class in a separate file and name the file like the class name (don't use !CamelCase names separate them with underlines). Create a separate header (ends with .h) and source file (ends with .cc). Example for class {{{MyExampleClass}}}.
@@ -26 +26 @@
 Place machine-dependent code in a special file so that it may be easily located when porting code from one machine to another.
 
+=== 80 Columns at Maximum ===
+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.''
+
 == Comments ==
 
@@ -35 +39 @@
 
 == Naming Conventions ==
+
 === Classes and Types ===
 Names representing types must be in mixed case starting with upper case.
@@ -46 +51 @@
 
 === Variables ===
-Variable names must be in mixed case starting with lower case.
+Variable names must be in mixed case starting with lower case. Each variable declaration on a new line. Avoid abbreviations in names.
 {{{
 string testString;
@@ -58 +63 @@
   int numberOfTimes_;
 };
-
+}}}
+Use useful names:
+{{{
+// wrong
+ProgressBar *prbar;
+string prtxt, errstr;
+ 
+// correct
+ProgressBar* downloadProgressBar;
+string progressText;
+string errorString;
+}}}
+''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 ==
-Named constants (including enumeration values) must be all uppercase using underscore to separate words. Always use constants instead of numbers.
+Named constants (including enumeration values) must be all uppercase using underscore to separate words. Always use constants instead of numbers. 
 {{{
 const int MAX_ITERATIONS = 5;
@@ -69 +86 @@
 
 === Functions ===
-Names representing methods or functions must be verbs and written in mixed case starting with lower case.
+Names representing methods or functions must be verbs and written in mixed case starting with lower case. Avoid abbreviations in names.
 {{{
 void calculateTheLowerBoundary() {}
 int howManyItemsLeft() {}
 }}}
-For interface functions to local member variables use short functions:
+For interface functions to local member variables use short functions (setter and getter functions):
 {{{
 class WorldEntity {
@@ -91 +108 @@
 }}}
 
+The name of the object is implicit, and should be avoided in a method name.
+{{{
+class Line {
+public:
+  float getLength(); // Not getLineLength() since it's clear that it is a line.
+};
+}}}
 
+=== Enumerations ===
+Enumeration constants can be prefixed by a common type name.
+{{{
+enum Color { 
+  COLOR_RED, 
+  COLOR_GREEN, 
+  COLOR_BLUE 
+};
+}}}
+
+=== Namespaces ===
+Names representing namespaces should be all lowercase.
+{{{
+namespace ioutil {
+
+}
+}}}
 
 == Indentation ==
 === Spaces ===
 Use 2 spaces for an indentation level. Never use tabs, as it is common in windows IDEs.
+
+
+== Whitespaces ==
+Use one space after each keyword
+
+
+
+
+
+
 
 == Special Implementations ==