On Tuesday 22 October 2002 02:59, Jonathan Riddell wrote:
> Say Luis, what's Force documentation and Force Sections ?
Force documentation means that there is going to be a comment block for t=
he=20
class and each of the mehtods, even if you didnt write any documentation =
for=20
them. for example
/** class Example
*
*/
class Example
{
//public section
public:
/**
*/
void thisIsAMethodThatISNotDocumented();
/**
* this is a method that has documentation and uses a
* @param a=20
*/
void anotherMehtod(int a);
};
If there is documentation for the class and/or method, then it's written =
to=20
the source, and if there is no documentation (class documentation and fir=
st=20
method for this example) you can force the program to still write the com=
ment=20
blocks (so that you can add it later)
Also, in the class declaration there are comments indicating where the=20
different sections begin (public, protected, private, attributes,=20
aggretations, etc)
normally this comments are only written if there is somthing in that sect=
ion=20
(ie, it wont write "//protected" if there are no protected methods, but i=
f=20
you want to you can force this as well...
hope its clear.
luis.
|