Skip to content

Commit b75a6ca

Browse files
bk2204jrn
authored andcommitted
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 <[email protected]> Signed-off-by: Jonathan Nieder <[email protected]>
1 parent 110f415 commit b75a6ca

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

Documentation/CodingGuidelines

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,14 @@ For C programs:
145145
they were describing changes. Often splitting a function
146146
into two makes the intention of the code much clearer.
147147

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+
148156
- Double negation is often harder to understand than no negation
149157
at all.
150158

0 commit comments

Comments
 (0)