Re:Patterns and Anti-Patterns in Code Comments
by einhverfr on Friday August 03, 2012 @12:35AM
(#4332560)
In that case, there's no reason to sign the comment. Signing adds very little here. It's entirely optional. It's a simple, objective description of what has been changed in the software, more like a footnote. However, if you are going to offer thoughts about what code, perhaps offer suggestions as to where things need to go, then signing is very important.
I really dislike seeing a comment that says "We OUGHT to X here" with no idea of who wrote it.
Also anything can be abused. Cautions about what sort of abuse to watch out for are very helpful.
/* Changed to meet CR 19837xyz, H.B. Smith, June 12, 1999 */
That's a minimal signed comment in "enterprise software". Usually, there's a huge flower box with required sections, few filled in, or at best marked "N/A". And then the highly pompous signature. People only do that because it's total CYA. Nobody will fault them for writing utter rubbish, and then signing it.
Tracking who did what changes, and why, that's for version control. Flower boxes, elaborate comment format requirements, and signatures, that just demonstrates that you're not even using RCS-grade version control.