CodingGuidelines: style for multi-line comments

bk2204 · jrn · commit b75a6ca7f3ab · 2013-10-14T12:48:06.000-07:00
The style for multi-line comments is often mentioned and should be documented
for clarity.

Signed-off-by: brian m. carlson &lt;sandals@crustytoothpaste.net&gt;
Signed-off-by: Jonathan Nieder &lt;jrnieder@gmail.com&gt;
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
@@ -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.
 
