aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorbrian m. carlson <sandals@crustytoothpaste.net>2013-10-12 00:45:46 +0000
committerJonathan Nieder <jrnieder@gmail.com>2013-10-14 12:48:06 -0700
commitb75a6ca7f3ab793e61b3229d29dceb7a4ec07cbc (patch)
tree5fc645c88665cf206bb77e2b901e64273ff53a53 /Documentation
parent110f415ce87730db48baae086b8c5f1344451bf4 (diff)
downloadgit-b75a6ca7f3ab793e61b3229d29dceb7a4ec07cbc.tar.gz
git-b75a6ca7f3ab793e61b3229d29dceb7a4ec07cbc.tar.xz
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>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/CodingGuidelines8
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index e5ca3b75d..a600e35c8 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -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.