On Mon, 22 Sep 2014 16:32:27 +0200, Jean-Michel Pichavant wrote:
> ----- Original Message -----
>> From: "Chris Angelico" <ros...@gmail.com>
>> Cc: python-list@python.org Sent: Saturday, 20 September, 2014 4:58:44
>> PM Subject: Re: Love to get some feedback on my first python app!!!
> [snip]
>>
>> #search API rawData =
>> urllib.urlopen('http://ajax.googleapis.com/ajax/services/search/
web?v=1.0&q='+encodedQuery).read()
>> #loads data from API into json jsonData = json.loads(rawData)
>> #extracts the results from API searchResults =
>> jsonData['responseData']['results']
>>
>> The more normal way to write these would be in present tense, in a more
>> imperative style: "Fix some bugs", "Load data", "Extract results".
>> (Although these comments are actually quite redundant - all they do is
>> tell you what the single next line of code does.)
>
> I used to belong to the cult "don't repeat yourself" in the comments,
> being angry against people who thought I couldn't understand by myself
> the simplest line of code.
>
> But I changed my mind. I've read some code comments over the years and
> best ones (imo) where those which where actually repeating themselves.
> Golden rules of comments:
>
> # state what you plan to do doIt()
>
> For instance:
>
> cells = ['a', 'b' 'c']
> # print the first cell print cell[1]
That is not too bad, "Print Customer name from cell 1" may be better as
it would stick out if the data structure changed
what is meant by don't state the obvious in comments is stating something
like "Increment x" without explaining why.
--
"It is hard to overstate the debt that we owe to men and women of genius."
-- Robert G. Ingersoll
--
https://mail.python.org/mailman/listinfo/python-list
