[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 08:24:51 +0200
I prefer declarative for my own stuff, since I once allowed me to take
a little time to actually read a style guide. But sometimes it still
happens an imperative slides in, since with imperative languages we
are thinking imperative. Otherwise, I would neeever bug anyone about
the style of comments, I'm thankful there are any! So my favorite
lower bound "one single line of english" per function and file, is
already something I'm thankful for, Independent if its imperative or
declerative. And if we bug people about imperative style, they might
just not do any comments with the favorite lie-excuse "code documents
itself".
On Tue, Mar 27, 2012 at 6:01 AM, Miles Bader <miles@gnu.org> wrote:
> David Manura <dm.lua@math2.org> writes:
>> For these reasons I recommend standardization on the declarative form
>
> Hint: ain't gonna happen.
>
> -miles
>
> --
> Cat, n. A soft, indestructible automaton provided by nature to be kicked when
> things go wrong in the domestic circle.
>