Changes between Version 26 and Version 27 of CodingStyle

Timestamp:

Aug 1, 2012, 1:37:09 PM (12 years ago)

Author:

Nicolas

Comment:

Formatting. Also changed {{{}}} to `` to make wiki code more readable.

CodingStyle

@@ -21 +21 @@
 
  * Names should be descriptive without being verbose (local variables names may be short).
- * Class and type names, and #defined symbols, are all upper case, with underscores to separate words.
+ * Class and type names, and `#defined` symbols, are all upper case, with underscores to separate words.
  * Variable and function names are all lower case, with underscores to separate words.
  * No mixed case names.
@@ -35 +35 @@
 );
 }}}
- * {{{switch}}} statements: {{{case}}} labels are at same indent level as {{{switch}}}:
+ * `switch` statements: `case` labels are at same indent level as `switch`
 {{{
 switch (foo) {
@@ -136 +136 @@
 === Includes === #includes
 
- * A `.cpp` file should have the minimum set of #includes to get that particular file to compile (e.g. the includes needed by {{{foo.cpp}}} should be in {{{foo.cpp}}}, not {{{foo.h}}}).
- * foo.cpp should include foo.h first; after that, includes should be ordered from general (`<stdio.h>`) to specific (`shmem.h`).
+ * A `.cpp` file should have the minimum set of #includes to get that particular file to compile (e.g. the includes needed by `foo.cpp` should be in `foo.cpp`, not `foo.h`).
+ * `foo.cpp` should include `foo.h` first; after that, includes should be ordered from general (`<stdio.h>`) to specific (`shmem.h`).
 
 === Extern declarations === #extern
 
- * {{{foo.h}}} should have '{{{extern}}}' declarations for all public functions and variables in {{{foo.cpp}}} There should be no '{{{extern}}}' statements in {{{.cpp}}} files.
+ * `foo.h` should have `extern` declarations for all public functions and variables in `foo.cpp` There should be no `extern` statements in `.cpp` files.
 
 === Use of static === #static
 
- * If a function or variable is used in only one file, declare it {{{static}}}.
+ * If a function or variable is used in only one file, declare it `static`.
 
 === Things to avoid unless there's a truly compelling reason: === #try-avoid