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

[Jose L. Z. <jlz...@ca...>]

El Mar 25 Sep 2001 13:56, escribiste:
> Hi Jose and others,
>
> Jose Luis Zabalza wrote:
> > I come back again about the idea of ** what ** do
> > a function or ** how ** do the function his work.
> > I believe is important the documentation show two
> > things.
>
> On the other hand, any function should be on a
> bit higher level of abstraction than the things
> inside the body.  Because of this, the comment
> for the whole function (member function) should
> be more abstract.  My experience is that you get
> less when you dig-out too much details.  While
> you may want to extract some points about how the
> function works, 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.


> If you want even more details, you can use
>   INLINE_SOURCES = YES
>   SOURCE_BROWSER = YES
> in your Doxyfile.

	Yes, but this is very noisely, it is more descriptive :
	
	- This.
	- If this
		- this.
	
	When you design a program. What is the first think you do ?

	I think in a algorithm. After I encode this algorithm. And if I have some 
time, I document the program. This is wrong. Doxigen help me to write the 
documentation near the code, so I write the documentation at same time.

>
> Once your project and documentation gets bigger,
> you will appreciate other features than digging
> out as much details as possible.  The opposite
> may be desired.  If the printed documentation
> would have 2000 pages, nobody would ever read and
> study it.  

	OK. It is posible, hide or show algorithm coments.


> I went through the
> same stage as you are going through now -- so I
> think that I can speak about having such
> experience.)

	OK ;-) I am a newbie.

>
> This is just my opinion.  The decision to accept
> it or not is yours.

	Thanks for your opinion. It is very interesting.

Regards
	
-- 
José Luis Zabalza
jlz...@ca...
Linux User 172551