Changeset 1779

Timestamp:

Jun 27, 2014, 12:32:51 AM (11 years ago)

Author:

Steven Levine

Message:

Update commenting notes.

File:

• trunk/CodingStyle.txt (modified) (1 diff)

trunk/CodingStyle.txt

@@ -162 +162 @@
   rarely generate better code than switch or if statement.
 
+Commenting code
+
+  Prefer javadoc style comments for function headers.
+
+  When usings // comments, // should be followed by a space.
+
+  Avoid using /* */ comments to disable code.  They can be hard to see.
+
 Disabling code