docs: Document practice of using comments for argument names #40247
Conversation
github-actions
bot
added
documentation
please-review
| Good: | ||
|
|
||
| ```c | ||
| myfunction(/* a= */ NULL, /* b= */ NULL, /* c= */ NULL); |
There was a problem hiding this comment.
we discussed preference of /* comment = */ over /* comment= */ no? IIRC you and @yuwata are generally onboard with the former too, but the others disagree. Better to iron this out too if documenting this properly
There was a problem hiding this comment.
I (slightly) prefer /* comment = */, but not strong opinion.
Better to iron this out too if documenting this properly
Yeah. I prefer consistent format of short comments, and that should be documented.
But, maybe better to not mix discussion here?
There was a problem hiding this comment.
I wouldn't call it "mixing discussion"? Once this is in it becomes the standard, hence we need to figure out the details?
There was a problem hiding this comment.
Let's be pragmatic here, 99% of comments are /* comment= */ now. Let's not introduce more busywork replacing all of those with /* comment = */
There was a problem hiding this comment.
Frankly, I don't really touch test/ that often hence I won't bother that much with comment or not there. But I really despise /* comment= */...
There was a problem hiding this comment.
Let's be pragmatic here, 99% of comments are
/* comment= */now. Let's not introduce more busywork replacing all of those with/* comment = */
Yeah, because I made the format consistent.
|
OK, let me make myself clear: I don't intend to enforce |
My stance is slightly different, I prefer to use consistent comment format. |
3 participants
No description provided.