[development] QA: Consensus on comment formatting

Gerhard Killesreiter gerhard at killesreiter.de
Sun Jan 7 16:20:23 UTC 2007


Angela Byron wrote:
>>
>> So! Anyone have a problem with these rules:
> 
> Gah! I copy/pasted the wrong chunk. :P
> 
> These! :)
> 
> * Comments are full sentences ending in periods, and are on their own 
> line unless they are documenting lists.
> * There is no blank line between %param and %return sections in function 
> documentation.

I'd prefer to have a blank line. Makes it easier to see what goes in and 
what comes out.

Cheers,
	Gerhard


More information about the development mailing list