This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: style convention: /*foo_p=*/ to annotate bool arguments
- From: Nathan Sidwell <nathan at acm dot org>
- To: Martin Sebor <msebor at gmail dot com>, GCC Mailing List <gcc at gcc dot gnu dot org>, Jeff Law <law at redhat dot com>, Jason Merrill <jason at redhat dot com>
- Cc: Aldy Hernandez <aldyh at redhat dot com>
- Date: Tue, 4 Oct 2016 07:40:09 -0400
- Subject: Re: style convention: /*foo_p=*/ to annotate bool arguments
- Authentication-results: sourceware.org; auth=none
- References: <672232b9-8cb4-71ad-ece6-e593545a4f07@gmail.com>
On 10/03/16 19:48, Martin Sebor wrote:
In a recent review Jason and I discussed the style convention
commonly followed in the C++ front end to annotate arguments
in calls to functions taking bool parameters with a comment
along the lines of
foo (1, 2, /*bar_p=*/true);
I like this if there's more than one boolean arg. If there's only one, I'm
ambivalent.
// In some header:
void foo (int, int, bool = -1);
// In some .c file:
void foo (int x, int y, bool bar_p /* = false */)
I think this is a good idea -- I've sometimes been puzzled by only looking at
the defn, because it happened to be in the same file as the call site I was
examining.
As has been mentioned, this does allow the decl and in-def comment to diverge.
How about something like:
void foo (int, T = ...);
void foo (int x, T y /* = default */)
{
}
?
nathan