Do not use C++ style comments (// comments). Strict ANSI C compilers do not accept them.

Started by PG Bug reporting formover 6 years ago5 messagesdocs
Jump to latest
#1PG Bug reporting form
noreply@postgresql.org

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/11/source-format.html
Description:

This sentence in the style guide feels outdated. // style comments have been
in the ANSI C standard for almost 20 years now (C99 was accepted as ANSI
standard in may 2000). I suggest rewording this to "Do not use C99 style
comments (// comments). Strict C89 compilers do not accept them." or come up
with some other reason for /**/ style being preferred to // style since I'm
not entierly convinced postgres compiles on C89 anyways.

#2Peter Eisentraut
peter_e@gmx.net
In reply to: PG Bug reporting form (#1)
Re: Do not use C++ style comments (// comments). Strict ANSI C compilers do not accept them.

On 2019-09-23 16:39, PG Doc comments form wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/11/source-format.html
Description:

This sentence in the style guide feels outdated. // style comments have been
in the ANSI C standard for almost 20 years now (C99 was accepted as ANSI
standard in may 2000). I suggest rewording this to "Do not use C99 style
comments (// comments). Strict C89 compilers do not accept them." or come up
with some other reason for /**/ style being preferred to // style since I'm
not entierly convinced postgres compiles on C89 anyways.

PostgreSQL 12 requires C99, so those guidelines should probably be
rephrased from "because old compilers don't accept it" to "because we
like it that way".

--
Peter Eisentraut http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

#3Tom Lane
tgl@sss.pgh.pa.us
In reply to: Peter Eisentraut (#2)
Re: Do not use C++ style comments (// comments). Strict ANSI C compilers do not accept them.

Peter Eisentraut <peter.eisentraut@2ndquadrant.com> writes:

PostgreSQL 12 requires C99, so those guidelines should probably be
rephrased from "because old compilers don't accept it" to "because we
like it that way".

Yeah, or more formally "to encourage consistent coding style".

regards, tom lane

#4Peter Eisentraut
peter_e@gmx.net
In reply to: Tom Lane (#3)
Re: Do not use C++ style comments (// comments). Strict ANSI C compilers do not accept them.

On 2019-09-25 00:13, Tom Lane wrote:

Peter Eisentraut <peter.eisentraut@2ndquadrant.com> writes:

PostgreSQL 12 requires C99, so those guidelines should probably be
rephrased from "because old compilers don't accept it" to "because we
like it that way".

Yeah, or more formally "to encourage consistent coding style".

fixed

--
Peter Eisentraut http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

#5Anders Åstrand
andast@kth.se
In reply to: Peter Eisentraut (#4)
Re: Do not use C++ style comments (// comments). Strict ANSI C compilers do not accept them.

<div dir='auto'>Thanks for your attention! That sentence made me believe the style guide was outdated, but then I found fairly recent posts referring to it and got confused.</div><div class="gmail_extra"><br><div class="gmail_quote">On Sep 26, 2019 10:53, Peter Eisentraut &lt;peter.eisentraut@2ndquadrant.com&gt; wrote:<br type="attribution" /><blockquote class="quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><p dir="ltr">On 2019-09-25 00:13, Tom Lane wrote:&#13;<br>
&gt; Peter Eisentraut &lt;peter.eisentraut@2ndquadrant.com&gt; writes:&#13;<br>
&gt;&gt; PostgreSQL 12 requires C99, so those guidelines should probably be&#13;<br>
&gt;&gt; rephrased from "because old compilers don't accept it" to "because we&#13;<br>
&gt;&gt; like it that way".&#13;<br>
&gt; &#13;<br>
&gt; Yeah, or more formally "to encourage consistent coding style".&#13;<br>
&#13;<br>
fixed&#13;<br>
&#13;<br>
-- &#13;<br>
Peter Eisentraut&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; http://www.2ndQuadrant.com/&amp;#13;&lt;br&gt;
PostgreSQL Development, 24x7 Support, Remote DBA, Training &amp; Services&#13;<br>
</p>
</blockquote></div><br></div>