CODEWITHSUNDEEP
javaeclipsejavadocautocreate
Ron Tuffin
Ron Tuffin

Reputation: 54619

Can one automatically create javadoc tags for an entire Eclipse project?

I know one can use '<alt><shift>J' to create tags for a single code element (class method for example).

But is there a way to automatically create these tags for every class in the entire project? Or even just at package or class level?

Upvotes: 2

Views: 4087

Answers (3)

Markus Lausberg
Markus Lausberg

Reputation: 12257

Automatic generated JavaDoc is a pain, because other people never now what the method should do and yourself will also not know it, when you look at the class one year later.

Please comment your methods by yourself or do not comment the method.

My company is using checkstyle to force the employers to add javadoc. Some employers hate it to comment their methods and just type sensless comments. It would be better that their is no comment than a useless.

With checkstyle you can find all undocumented methods, to document them in a well format.

What will help you to document an init method like

"init has to be called before any other method and initializes the class ActionDummy"

it is better to tell what exactly is done

Inizializes the default state of the action provider. Some state variables can be overriden by the listener when ....

Upvotes: 2

Michael Borgwardt
Michael Borgwardt

Reputation: 346260

Not that I know of.

What would that be good for anyway? Autogenerated Javadoc comments are worse than useless; I'd rather not have them cluttering up my code, and Javadoc will provide as much information even with no comment present.

Upvotes: 2

akarnokd
akarnokd

Reputation: 69997

Have you looked at JAutodoc?

Upvotes: 3

Related Questions