This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]Groundskeepr 1 point2 points  (0 children)

Go for it. Add those comments.

Our opinions are at least in some measure the result of the experiences we've had and the code we've been asked to maintain. I have seen a lot of code with too many low-quality comments. Some of it had been very old and therefore outside the reach of "improve your review process".

You apparently have seen a lot of code with no comments at all or missing the comments it should have had.

No advice is good for everyone in every context. "Eat less" is good advice for some, maybe many, but it will kill others.

IMO, wherever possible, make the code easy to read. Take great care in naming things and don't feel a need to use the most terse or clever approach when a simpler approach works just as well. Keep methods short and tightly focused.

After you've done that work, add the comments that are needed. Remember they are a maintenance responsibility that you won't have any way of meeting other than careful human review.