Path: csiph.com!x330-a1.tempe.blueboxinc.net!newsfeed.hal-mli.net!feeder1.hal-mli.net!border3.nntp.dca.giganews.com!border1.nntp.dca.giganews.com!border4.nntp.dca.giganews.com!border2.nntp.dca.giganews.com!nntp.giganews.com!novia!news-out.readnews.com!news-xxxfer.readnews.com!panix!not-for-mail
From: Grant Edwards <invalid@invalid.invalid>
Newsgroups: comp.lang.python
Subject: Re: The worth of comments
Date: Fri, 27 May 2011 17:53:15 +0000 (UTC)
Organization: PANIX Public Access Internet and UNIX, NYC
Lines: 35
Message-ID: <irooea$kio$2@reader1.panix.com>
References: <mailman.8533.1306409304.9058.python-list@python.org> <mailman.2126.1306435826.9059.python-list@python.org> <87sjs0apgh.fsf@benfinney.id.au> <iroadr$3gj$1@reader1.panix.com> <4ddfd9bf$0$49183$e4fe514c@news.xs4all.nl>
NNTP-Posting-Host: dsl.comtrol.com
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
X-Trace: reader1.panix.com 1306518795 21080 64.122.56.22 (27 May 2011 17:53:15 GMT)
X-Complaints-To: abuse@panix.com
NNTP-Posting-Date: Fri, 27 May 2011 17:53:15 +0000 (UTC)
User-Agent: slrn/pre0.9.9-102 (Linux)
Xref: x330-a1.tempe.blueboxinc.net comp.lang.python:6416

On 2011-05-27, Irmen de Jong <irmen@-NOSPAM-xs4all.nl> wrote:
> On 27-05-11 15:54, Grant Edwards wrote:
>> On 2011-05-27, Ben Finney<ben+python@benfinney.id.au>  wrote:
>>> Richard Parker<r.richardparker@comcast.net>  writes:
>>>
>>>> On May 26, 2011, at 4:28 AM, python-list-request@python.org wrote:
>>>>
>>>>> My experience is that comments in Python are of relatively low
>>>>> usefulness. (For avoidance of doubt: not *zero* usefulness, merely
>>>>> low.)
>>
>> I've seen plenty of comments who's usefulness was not zero.  It was
>> less than zero.
>
> Someone once taught me, "There is one thing worse than having no 
> comments in the source code: having incorrect (or 'lying') comments
> in the code."
>
> Grant, I guess you hint at such comments?

Yes.  :)

When trying to find a bug in code written by sombody else, I often
first go through and delete all of the comments so as not to be
mislead.

The comments reflect what the author _thought_ the code did
_at_some_point_in_the_past_.  What matters is what the code actually
does at the present.

-- 
Grant Edwards               grant.b.edwards        Yow! ... If I had heart
                                  at               failure right now,
                              gmail.com            I couldn't be a more
                                                   fortunate man!!