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>
brian m. carlson committed
Oct 12, 2013 at 00:45 UTC
b75a6ca7f3ab793e61b3229d29dceb7a4ec07cbc
1 file changed
+8
Documentation/CodingGuidelines
+8
@@ -145,6 +145,14 @@ For C programs:
145
they were describing changes. Often splitting a function
146
into two makes the intention of the code much clearer.
147
148
+ - Multi-line comments include their delimiters on separate lines from
149
+ the text. E.g.
150
+
151
+ /*
152
+ * A very long
153
+ * multi-line comment.
154
+ */
155
+
156
- Double negation is often harder to understand than no negation
157
at all.
158