RE: [Doxygen-users] [Large] Algorithmics comments or comments ins ide body functions.

[Prikryl,Petr <PRI...@sk...>]

...one more comment ;-)

Jose Luis Zabalza wrote:
>
> Petr Prikryl wrote:
> >
> > [...] any function should be on a
> > bit higher level of abstraction [...]
> > for me it is much easier to
> > sketch the idea more roughly in the comment
> > outside the body.
>
> OK. I think so. It's all right. But, when you have hurry up is very easy 
> forget the generic abtract comment but it's easy to write a little coment 
> near the for keyword, or near the if keyword or near the return keyword.

I see.  You are not the only one to forget this.
Often, the final form of the comment is known 
only after the final implementation.  In such case,
I use \todo command, like here:

/*! \brief This is brief description.
  
  This is the abstract comment describing less briefly
  the functionality.  But it is not finished!

\todo Update the comment.
*/
int f()
{
   return 42;  // i.e. solving the same problem in constant time ;-)
}

HTH,
  Petr

-- 
Petr Prikryl, SKIL, spol. s r.o., pri...@sk...