Re: [Doxygen-users] [Large] Algorithmics comments or comments ins ide body functions.
Brought to you by:
dimitri
|
From: Jose L. Z. <jlz...@ca...> - 2001-09-26 17:14:19
|
El Mié 26 Sep 2001 11:40, escribiste:
> ...one more comment ;-)
>
> > 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 ;-)
> }
>
This is the first step to don't write the documentation ;-)
Regards
--
José Luis Zabalza
jlz...@ca...
Linux User 172551
|