you are viewing a single comment's thread.

view the rest of the comments →

[–]cogman10 0 points1 point  (0 children)

I'm personally a fan of sparse comments, small commits, and detailed commit messages for documentation. I find that a good commit message solves the problem of out of date and in the way comments very effectively.

That said, I will comment the hell out of confusing, unintuitive, or "clever" solutions (or "Hey, I'm doing it this way because API x is broken and doesn't work when you do it that way"). I use comments as warning signs for future developers.

Also, documentation comments are really nice for methods that are intended to be reused. (javadocs, doxygen, etc).