CodingGuidelines: style for multi-line comments
authorbrian m. carlson <sandals@crustytoothpaste.net>
Sat, 12 Oct 2013 00:45:46 +0000 (12 00:45 +0000)
committerJonathan Nieder <jrnieder@gmail.com>
Mon, 14 Oct 2013 19:48:06 +0000 (14 12:48 -0700)
The style for multi-line comments is often mentioned and should be documented
for clarity.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Documentation/CodingGuidelines

index e5ca3b7..a600e35 100644 (file)
@@ -145,6 +145,14 @@ For C programs:
    they were describing changes.  Often splitting a function
    into two makes the intention of the code much clearer.
 
+ - Multi-line comments include their delimiters on separate lines from
+   the text.  E.g.
+
+       /*
+        * A very long
+        * multi-line comment.
+        */
+
  - Double negation is often harder to understand than no negation
    at all.