[PATCH] CodingGuidelines: style for multi-line comments

From: brian m. carlson <sandals@crustytoothpaste.net>
Date: Oct 12, 2013, 00:45 UTC
Message-ID: <1381538746-835885-1-git-send-email-sandals@crustytoothpaste.net>

The style for multi-line comments is often mentioned and should be documented for clarity.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
---
 Documentation/CodingGuidelines | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index e5ca3b7..a584062 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 should 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.

-- 
1.8.4