I just wrote a line of code, then added a comment before it.
//these tests don’t bubble up, so… test.Reset();
Then I thought, “Why am I commenting that? Isn’t the code’s intent explicit enough?” It is quite clear what the code is doing (resetting a test). However, the comment is necessary to give some insight into the business reason for the code.
The comment is useful because the instructions in the code may contradict the expected business logic. If the action (resetting the test) was expected, it would not be necessary to add the comment; that wasn’t the case for me.
This is an example of what I call a defensive comment. It helps avoid the situation where someone looks at code and wonders whether it is logically incorrect. That someone may be another programmer, or it may be yourself, months after you’ve forgotten why you wrote the code in the first place.
Lots of people say that code should be self-commenting. This doesn’t work in all situations. We shouldn’t fear a brief one-line comment to help give our code context and spoken-language meaning. Comments need not be offensive when used defensively.
One thought on “Code comments: the best defense need not be offensive”
Nick Mallare says:
My logic has always been that you cannot over-comment code. Always safer to err on the safe side.