Kerry Buckley

What’s the simplest thing that could possibly go wrong?

Comments aren’t always evil

4 comments

I tend to agree that comments are, in most cases, evil (or at least mildly malevolent), but I did come across one of the exceptions to the rule today.

While doing a bit of drive-by refactoring while fixing a bug, I reflexively changed this line:
[ruby]
unless instance_response.nil?
[/ruby]
to this:
[ruby]
if instance_response
[/ruby]

Then reading the comment above the line, expecting to delete it, it all came flooding back:
[ruby]
# Use instance_response.nil? to check if the HTTParty
# response’s inner hash is empty.
# If you use ‘if instance_response’, it is always true.
[/ruby]

Now you could maybe argue that this unexpected behaviour is because httparty uses just a little too much of that old method missing proxy magic (which of course isn’t really magic at all), but that’s not the point of this post.

In the end I pulled it out into a private method to make it clearer what was going on, but decided to leave the comment in.

[ruby]
def self.instance_returned? instance_response
# Use instance_response.nil? to check if the HTTParty
# response’s inner hash is empty.
# If you use ‘if instance_response’, it is always true.
!instance_response.nil?
end
[/ruby]

Written by Kerry

August 14th, 2009 at 9:21 pm

4 Responses to 'Comments aren’t always evil'

Subscribe to comments with RSS or TrackBack to 'Comments aren’t always evil'.

  1. So shortly after posting about the evilness of code comments, comments on your blog stop working? Interesting…

    Anyway, why are comments evil?
    (Your link leads to a 1 hr podcast… )

    Sure, they can be overused – but they can also be very useful and important.

    Even Python code (*bait*) isn’t always obvious enough to not require explanatory comments.

    As a general rule of thumb, I think the code explains the *what* while comments explain the *why*.

    I’d rather have too much commenting than too little.

    FND

    15 Aug 09 at 8:27 pm

  2. Obviously ‘evil’ is, as ever, an exaggeration, but comments should be a last resort. Much better to make the intention clear by, for example, extracting a local variable or provate method and giving it a meaningful name. Obviously there are some cases where comments are useful, but I like to only put them in when I can’t think of a way of clarifying things in the code itself.

    The insidious thing about unnecessary comments is that they tend to go out-of-date. People change the code, but leave the comments, so they end up describing behaviour that’s no longer there, or they get separated from the code they were supposed to describe.

    Kerry

    15 Aug 09 at 8:52 pm

  3. You could use a method whose name explains what the line of code does but it would probably be reflexively inlined by someone who sees it later anyway.

    Darren

    16 Aug 09 at 4:17 pm

  4. Thanks Kerry.
    I actually agree with that description. So I guess it’s just the “comments are evil” rallying cry being a bit too misleading…

    FND

    19 Aug 09 at 12:26 pm

Leave a Reply

You must be logged in to post a comment.