Changeset 1776

Timestamp:

Jun 12, 2014, 5:53:06 PM (11 years ago)

Author:

Steven Levine

Message:

Correct typos.
Add Disabling Code section.

File:

• trunk/CodingStyle.txt (modified) (5 diffs)

trunk/CodingStyle.txt

@@ -41 +41 @@
   if (expr) statement;
 
-  // If statment is long, split logically and use braces.
+  // If statement is long, split logically and use braces.
   if (expr) {
     statement_part1...
@@ -106 +106 @@
 
     BOOL is_ok;
-  
-  Local varibles can be short as long as meaning is clear.
+
+  Local variables can be short as long as meaning is clear.
 
     BOOL ok;
@@ -114 +114 @@
 
     USHORT maxcnt;
-  
+
 Spaces
 
@@ -148 +148 @@
     return (0);
 
-  Do not use superfluous parens when operator precedence with do the
+  Do not use superfluous parens when operator precedence will do the
   right thing.
 
@@ -161 +161 @@
   Avoid nested ternary conditionals (i.e. ? :).  They are hard to read and
   rarely generate better code than switch or if statement.
+
+Disabling code
+
+  When disabling multiple lines of code, prefer
+
+    #if 0
+    #endif
+
+  to
+
+    /*
+    */
+
+  comments or // comments.
+
+  When disabling multiple lines of code, it is acceptable to use // comments
+  to disable a single line.  The // should be followed by a trailing space
+
+    // DbgMsg("here");
 
 Memory