Geek Answers Handbook

JavaDoc - Can I divide methods into groups?

I am currently creating documentation for a class with many functions. Is there a way to organize JavaDoc so that the methods in the overview are divided into several categories?

+7
java javadoc
source share
3 answers

Perhaps try reorganizing it so that you don't have "many functions" inside the same class. It is much better to divide the code into small fractions that are easier to maintain, read, test, debug, document, etc.

+3
source share

The JavaDoc tool does not have this functionality. Even JDK methods are not grouped this way.

+2
source share

I'm afraid this is not Javadoc - but doxygen supports grouping elements in output.

I used doxygen in the Javadoc preference for personal projects, as well as for multilingual projects professionally. The format of the documentation comments is for the most part fairly close to Javadoc, but I found it much richer and more extensible, and the output is simply better.

Heck, for one project, we published the User Guide and API Guide in PDF format via doxygen ...

+1
source share

More articles:


All Articles