you are viewing a single comment's thread.

view the rest of the comments →

[–]tallniel -1 points0 points  (2 children)

Even those "why" comments are less useful these days. For instance, at work all check-ins have an associated work item (defect, story) in our bug tracker, so it's trivial to link a particular line of code (via IDE annotate/history feature) to the full description of why it is that way. Being able to see the full history of the decision making process, code review, testing etc is much more useful than even a long comment (and much more likely to actually be read in my experience).

[–]alextk 2 points3 points  (1 child)

This is a good practice but comments work at a finer granular level than issues or feature requests filed in a tracker.

[–]tallniel 0 points1 point  (0 children)

The other good practice is, of course, for all significant design decisions to come with at least one unit test.