From: brian m. carlson <sandals@crustytoothpaste.net>
Date: Sat, 12 Oct 2013 00:45:46 +0000 (+0000)
Subject: CodingGuidelines: style for multi-line comments
X-Git-Tag: v1.8.5-rc0~58
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=b75a6ca7f3ab793e61b3229d29dceb7a4ec07cbc;p=thirdparty%2Fgit.git

CodingGuidelines: style for multi-line comments

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>
---

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index e5ca3b75d3..a600e35c81 100644
--- 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.