mirror of
https://github.com/xen-project/xen.git
synced 2026-10-28 02:01:24 +01:00
CODING_STYLE: Allow single-sentence comments without full stops
One of the common ways in which contributors trip up over the CODING_STYLE guides is by not putting a full stop at the end of a comment when there is only a single sentence. Calling these out is a waste of everybody's time: The full stop at the end of a comment with a single sentence (or a single phrase) adds absolutely nothing to the legibility of the code. Modify CODING_STYLE to allow comments with a single sentence or sentence fragment to either have a full stop or not, while making it clear that comments with multiple sentences must have a full stop at the end of each sentence. Signed-off-by: George Dunlap <george.dunlap@citrix.com> Acked-by: Ian Jackson <ian.jackson@citrix.com>
This commit is contained in:
1 parent
72798298c7
commit
78ac45c9af
1 file changed
+3
-1
+3
-1
@@ -93,7 +93,9 @@ Comments
|
||||
|
||||
Only C style /* ... */ comments are to be used. C++ style // comments
|
||||
should not be used. Multi-word comments should begin with a capital
|
||||
letter and end with a full stop.
|
||||
letter. Comments containing a single sentence may end with a full
|
||||
stop; comments containing several sentences must have a full stop
|
||||
after each sentence.
|
||||
|
||||
Multi-line comment blocks should start and end with comment markers on
|
||||
separate lines and each line should begin with a leading '*'.
|
||||
|
||||