Changes between Version 5 and Version 6 of CodingStyle

Timestamp:

Dec 22, 2007, 5:26:26 PM (17 years ago)

Author:

Nicolas

Comment:

More monospaced formatting

CodingStyle

@@ -8 +8 @@
  * If a function becomes longer than 100 lines or so, split it up.
  * If a file is becoming 'landfill', split it up.
- * C++ .h files often contain both interface and implementation. Clearly divide these.
+ * C++ `.h` files often contain both interface and implementation. Clearly divide these.
 
 === Code documentation ===
 
- * .C files have a comment at the top saying what's in the file (and perhaps what isn't).
+ * `.C` files have a comment at the top saying what's in the file (and perhaps what isn't).
  * Functions are preceded by a comment saying what they do.
- * Structs and classes are preceded by a comment saying what they are.
+ * structs and classes are preceded by a comment saying what they are.
 
 === Naming ===
@@ -86 +86 @@
 === Includes ===
 
- * A .C file should have the minimum set of #includes to get that particular file to compile (e.g. the includes needed by {{{foo.C}}} should be in {{{foo.C}}}, not {{{foo.h}}}).
+ * A `.C` file should have the minimum set of #includes to get that particular file to compile (e.g. the includes needed by {{{foo.C}}} should be in {{{foo.C}}}, not {{{foo.h}}}).
  * Includes should be ordered from general (`<stdio.h>`) to specific (`thisfile.h`).
 
@@ -105 +105 @@
 === Things to avoid ===
 
- * Use {{{typedef}}} (not {{{#define}}}) to define types.
- * Don't use {{{memset()}}} or {{{memcpy()}}} to initialize or copy classes that are non-C compatible. Write a default constructor and a copy constructor.
+ * Use `typedef` (not `#define`) to define types.
+ * Don't use `memset()` or `memcpy()` to initialize or copy classes that are non-C compatible. Write a default constructor and a copy constructor instead.
 
 === Error codes ===