mirror of
https://github.com/git/git
synced 2024-09-18 07:51:35 +00:00
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>
This commit is contained in:
parent
110f415ce8
commit
b75a6ca7f3
|
@ -145,6 +145,14 @@ For C programs:
|
||||||
they were describing changes. Often splitting a function
|
they were describing changes. Often splitting a function
|
||||||
into two makes the intention of the code much clearer.
|
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
|
- Double negation is often harder to understand than no negation
|
||||||
at all.
|
at all.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue