From: Stephen Kellett <snail@...>
Date: 2005-04-28T21:49:34+09:00
Subject: Re: Comments Are More Important Than Code

>Mark Smith wrote:
>> two's.  However, a comment like "Apply this to the even pages
>> in the report" explains to a code reader WHY the loop is
>> stepping by two's . . .

Yes. I think one of the things that gets commenting a bad name is stupid
company rules that mandate there must be a comment every N lines. When
you *have* to put a comment in to make the comment-checker happy before
submission to version control then you get stupid comments.

        i++;    // comment to make comment checker happy.

This sends your line manager into orbit, so then you get

        i++;    // move to next index

which your line manager can't argue about but which really doesn't add
any value either as it was obvious in the context of the rest of the
code (quite apart from the fact that there is nice large description of
what is going on only a few lines earlier in the code).

Stephen
-- 
Stephen Kellett
Object Media Limited    http://www.objmedia.demon.co.uk
RSI Information:        http://www.objmedia.demon.co.uk/rsi.html