From: "Jon A. Lambert" <jlsysinc@...>
Date: 2005-04-30T16:56:43+09:00
Subject: Re: Comments Are More Important Than Code

Tom Ayerst wrote:
> Mark Smith wrote:
>> James Britt said the following on 4/27/2005 7:14 PM:
>>
>>
>> Of course, a comment like "Step through by twos" does NOTHING to
>> help a code reader understand that the loop is stepping by 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 . . .
>>
>
> On the other hand having the loop in a method called report_formatter
> calling two methods called "even_number_page_formatter" and
> "odd_number_page_formatter" would do that too...
>
> <fx:ducks> ;-)

Actually you touch on an interesting point.  At thet time of the change 
above, it would be appropriate to delete the comments as they aren't 
necessary or accurate.   Dead comments are worse than dead code.  You can 
tell that code is dead because it's commented out.

Then again what is needed of course is a way to comment comments out to 
indicate they are dead too!  ;-)

## Ignore the following comment as it is no longer accurate
# Step through by twos
## Resume reading comments

--
J. Lambert