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.
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.