# [PATCH] CodingGuidelines: style for multi-line comments 1 messages from 2013-10-12 to 2013-10-12. Participants: brian m. carlson. Thread: https://gitlist.dev/t/35112 ## brian m. carlson, 2013-10-12 00:45 Subject: [PATCH] CodingGuidelines: style for multi-line comments Message-ID: <1381538746-835885-1-git-send-email-sandals@crustytoothpaste.net> URL: https://gitlist.dev/e/1381538746-835885-1-git-send-email-sandals%40crustytoothpaste.net ``` The style for multi-line comments is often mentioned and should be documented for clarity. Signed-off-by: brian m. carlson --- Documentation/CodingGuidelines | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index e5ca3b7..a584062 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 should 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. -- 1.8.4 ```