threads / patch / 64981

patchCodingGuidelines: document // comments

Subject: [PATCH] CodingGuidelines: document // comments

## tl;dr

2 messages between Feb 11, 2026 and Feb 12, 2026. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Junio C Hamano· Feb 11, 2026, 19:17 UTC · lore

We do not use // comments in our C code, which is implied by the description of multi-line comment rule and its examples, but is not explicitly spelled out. Spell it out.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/CodingGuidelines | 2 ++
 1 file changed, 2 insertions(+)
Show changes to Documentation/CodingGuidelines +2 −0
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index b358d6bfb8..507d52b0d3 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -439,6 +439,8 @@ For C programs:
 	 */
 	_("Here is a translatable string explained by the above.");
 
+   We do not use // comments.
+
  - Double negation is often harder to understand than no negation
    at all.
 
-- 
2.53.0-247-g50a2c88be3
Patrick Steinhardt· Feb 12, 2026, 07:05 UTC · re: Junio C Hamano · lore

Re: [PATCH] CodingGuidelines: document // comments

On Wed, Feb 11, 2026 at 11:17:48AM -0800, Junio C Hamano wrote:
Show 21 quoted lines
> We do not use // comments in our C code, which is implied by the
> description of multi-line comment rule and its examples, but is not
> explicitly spelled out.  Spell it out.
> 
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  Documentation/CodingGuidelines | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index b358d6bfb8..507d52b0d3 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -439,6 +439,8 @@ For C programs:
>  	 */
>  	_("Here is a translatable string explained by the above.");
>  
> +   We do not use // comments.
> +
>   - Double negation is often harder to understand than no negation
>     at all.
Makes sense and looks good to me. Thanks!
Patrick

← back to recent threads