[development] QA: Consensus on comment formatting

Robert Douglass rob at robshouse.net
Mon Jan 8 14:20:06 UTC 2007

Just adding my agreement to the following comment. There is good IDE 
support for these:

Rob Barreca wrote:
>> * Eliminate inappropriate uses of all caps, e.g, NOTE. 
> Think we should allow NOTE and WARNING as long as they are used like 
> TODOs -- with a capitalized sentence/period. All these are good in my 
> mind.
> // TODO: Optimize this query.
> // WARNING: Don't do that.
> // NOTE: May smell funky.

More information about the development mailing list