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>
maint
brian m. carlson 2013-10-12 00:45:46 +00:00 committed by Jonathan Nieder
parent 110f415ce8
commit b75a6ca7f3
1 changed files with 8 additions and 0 deletions
Documentation

View File

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