Skip to content

Commit 1b4a4cc

Browse files
author
Laszlo Ersek
committed
comments: restrict and clarify applicability of "/*" comments
Section "6.2 Comments" seems to permit "/*" for multi-line comments in general. That's incorrect; "/*" comments are permitted only for a subset of multi-line comments (namely Doxygen-style file and function header comment blocks). Update the rule accordingly. Cc: Andrew Fish <[email protected]> Cc: Leif Lindholm <[email protected]> Cc: Michael D Kinney <[email protected]> Cc: Rebecca Cran <[email protected]> Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=607 Signed-off-by: Laszlo Ersek <[email protected]> Reviewed-by: Philippe Mathieu-Daude <[email protected]> Reviewed-by: Leif Lindholm <[email protected]> Reviewed-by: Michael D Kinney <[email protected]>
1 parent 0f75934 commit 1b4a4cc

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

6_documenting_software/62_comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ minimal familiarity with the code. Clarity is important, but one should also
5454
strive for terse and concise comments. One should be able to see both the
5555
comment, and the code being commented on, on the same screen.
5656

57-
### 6.2.1 Only use C style, "/*", comments for multi-line comments and on the same line as pre-processor directives.
57+
### 6.2.1 Only use C style, "/*", comments on the same line as pre-processor directives, and in Doxygen-style file and function header comment blocks.
5858

5959
Compile can vary in their support for use of `//` in preprocessor directives
6060
(e.g. `#define`). Note that the mixing of `/* ... */` and `//` is not handled

0 commit comments

Comments
 (0)