[Date Prev][Date Next][Thread Prev][Thread Next]
[Date Index]
[Thread Index]
- Subject: Re: documentation style - 2nd/3rd person tense for function comments
- From: Axel Kittenberger <axkibe@...>
- Date: Tue, 27 Mar 2012 09:12:40 +0200
Its like the breaking glass from that episode of "how I met your
mother", once you are made aware of it, you will no longer be able to
stop noticing it all the time :-)
(At least I when reading my own code I get a little itch when I notice
that I had made an imperative once again. While descritive is prefered
for function headers since they describe the function, I tried to
write inline comments also descriptive for consitency, that on the
other hand often felt wierd. )
On Tue, Mar 27, 2012 at 9:00 AM, Enrico Colombini <erix@erix.it> wrote:
> On 27/03/2012 8.43, andreas graeper wrote:
>>
>> can you imagine there are people which wouldn't even realize the
>> difference
>> if they wasn't made aware of it.
>
>
> It took a long time for me, as non-English speaker, to notice it :-)
>
> --
> Enrico
>