Skip to content

Commit

Permalink
CodingGuidelines: style for multi-line comments
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
brian m. carlson authored and Jonathan Nieder committed Oct 14, 2013
1 parent 110f415 commit b75a6ca
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions Documentation/CodingGuidelines
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit b75a6ca

Please sign in to comment.