News for hackers. Stuff that matters.

A comment on I no longer understand my PhD dissertation. Parent comment

Re:I no longer understand my PhD dissertation by JamesBarney on Monday February 15, 2016 @12:59AM (#11101742)
Names for classes, methods, parameters, and variables all suffer from this same problem. I think the solution to align code and comments is code reviews. Not writing comments also works but fails to solve related issues.
[ Parent | on HN ]
Re:I no longer understand my PhD dissertation by u801e on Monday February 15, 2016 @01:41AM (#11101851)
Where I work, I've always required that code that's submitted for review has a descriptive commit message. That is, the commit should explain what the problem was and how it was fixed, and why it was done that way.

This way, I can run git blame (or the equivalent VCS command) on the file and get a reasonable set of comments that usually match up with the code.

[ Parent | on HN ]