Skip to content

Commit 0f75934

Browse files
author
Laszlo Ersek
committed
comments: remove "Horror Vacui" rule
The rule about avoiding comments in C code where the opening comment characters are alone on a line conflicts with everyday edk2 practice -- we use comments like // // If the total number of lines in the popup is zero, then ASSERT() // all the time. This comment style is actively enforced by reviewers and maintainers. Remove the rule in order for the CCS to match reality. 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: Leif Lindholm <[email protected]> Reviewed-by: Michael D Kinney <[email protected]>
1 parent d096859 commit 0f75934

File tree

1 file changed

+1
-17
lines changed

1 file changed

+1
-17
lines changed

6_documenting_software/62_comments.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -66,23 +66,7 @@ not behave the same.
6666
Banners can be useful to highlight logical divisions within a file; such as
6767
before vital sections. This type of usage should be minimized.
6868

69-
### 6.2.3 Avoid comments where the opening comment characters are alone on a line.
70-
71-
```
72-
/*
73-
* VIOLATION: Horror Vacui
74-
*/
75-
```
76-
77-
or
78-
79-
```c
80-
//
81-
// VIOLATION: Horror Vacui
82-
//
83-
```
84-
85-
### 6.2.4 Do not include jokes or obtuse references in comments.
69+
### 6.2.3 Do not include jokes or obtuse references in comments.
8670

8771
```
8872
"Out of cheese error! Redo from start."

0 commit comments

Comments
 (0)