[bind10-dev] XXX, TODO, and suchlike

[Stephen Morris]

On 17/03/2011 08:34, Michal 'vorner' Vaner wrote:
> Hello
> 
> On Thu, Mar 17, 2011 at 01:03:44AM +0100, Shane Kerr wrote:
>>         We often leave comments including "XXX", "TODO", etc, to
>>         indicate the relevant code fragment has a potential problem or
>>         needs to be revisited by the release time, etc.
>>
>>         Right now, different developers use different keywords, but it's
>>         better to have a consistent style project-wide.
> 
> I myself don't like XXX, as it is non-descriptive. I use TODO and FIXME, which
> are different ‒ TODO means it needs additional functionality, while FIXME is
> functionality, that exists but is in some way broken. I believe there's place
> for both of them, because they are different.

+1

> Anyway, to make the matters little bit more complicated, there's also doxygen
> \todo, which brings the notes to a project-wide place. That's nice feature. I
> use it for higher level stuff like API design considerations, while the TODO and
> FIXME for things in lower-level code (when I don't know what it should do, I put
> it as \todo, while when I know what it should do but I'm lazy, it's TODO).

I think that's a useful distinction.

Stephen