From b75a6ca7f3ab793e61b3229d29dceb7a4ec07cbc Mon Sep 17 00:00:00 2001 From: "brian m. carlson" Date: Sat, 12 Oct 2013 00:45:46 +0000 Subject: [PATCH] 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 Signed-off-by: Jonathan Nieder --- Documentation/CodingGuidelines | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index e5ca3b75d3..a600e35c81 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. -- 2.11.4.GIT