The worth of comments

[Patty]

----- Original Message ----- 
From: "Richard Parker" <r.richardparker at comcast.net>
To: <python-list at python.org>
Sent: Thursday, May 26, 2011 11:50 AM
Subject: The worth of comments


> On May 26, 2011, at 4:28 AM, python-list-request at 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 can name variables, functions and classes with sensible, self-
>> documenting names. Why write:
>>
>> x = get_results(arg)  # x is a list of 1 or more results
>> [... much later]
>> for y in x:
>>    # process each result in turn
>>    do_something_with(y)
>
> (It occurred to me that I should use a specific subject for this 
> discussion.)
>
> I'm less inclined to use comments on each line, or selected lines, but 
> rather use block comments instead. They require more thought and time to 
> write; however, the intended functionality of the code that follows can be 
> described in full.
>
> -- 
> http://mail.python.org/mailman/listinfo/python-list
>
>

Hello Richard - I was recently complimented in a phone screen interview for 
including comment blocks exactly as you describe above.

Regards,

Patty