From c920e651e6d93794bf021706d0a7f5df0c0a88e6 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 15 Dec 2017 10:26:07 +0100 Subject: [PATCH] CODING_STYLE: provide better explanation why /* */ over // (#7647) Let's provide a real reason why /* */ should be used for commenting, rather than //, beyond mere taste. (This ultimately simply codifies how I use // vs. /* */ comments, and I think this is useful as an explanation and reason hence.) --- CODING_STYLE | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CODING_STYLE b/CODING_STYLE index 4119cfec23..ae818126cb 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -1,9 +1,11 @@ - 8ch indent, no tabs, except for files in man/ which are 2ch indent, and still no tabs -- We prefer /* comments */ over // comments, please. This is not C++, after - all. (Yes we know that C99 supports both kinds of comments, but still, - please!) +- We prefer /* comments */ over // comments in code you commit, please. This + way // comments are left for developers to use for local, temporary + commenting of code for debug purposes (i.e. uncommittable stuff), making such + comments easily discernable from explanatory, documenting code comments + (i.e. committable stuff). - Don't break code lines too eagerly. We do *not* force line breaks at 80ch, all of today's screens should be much larger than that. But