简体繁体中英

JavaDoc - Can I divide methods into groups?

原文 2016-03-15 16:08:51 0 3 java/ javadoc

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

3 answers

Maybe try to refactor it so you don't have "many functions" inside one class. It is much better to divide code into small fractions that are easier for maintaining, readability, testing, debugging, documenting etc..

The JavaDoc tool does not have such a functionality. Even the JDK's methods aren't grouped in such a fashion.

I am afraid its not Javadoc - but doxygen supports grouping items in the output.

I've used doxygen in preference to Javadoc for personal projects, and for multi-language projects professionally. The documentation comment format is close enough to Javadoc for the most part, but I've found it much richer and extendable, and the output is just better.

Heck, for one project we published the Users Guide and API Guide as PDF through doxygen...

How can I get the javadoc of all methods with a specific Annotation, with the method name and package/class name?

Intellij: Javadoc I can't see description of the methods, class in java documentation after ctrl+b

How can I avoid semi-repeating groups of methods in java?

How can I divide an arraylist of custom objects into groups of x based on the attributes of each object in the arraylist?

Javadoc methods and inherited methods

How can I dynamically assign test groups to test methods and @BeforeXXX and @AfterXXX annotated methods during runtime?

can we make JavaDoc tool to parse comments inside methods?

JavaDoc: private fields and methods

JAVADOC for private methods (BlueJ)

Grouping javadoc methods

暂无

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

Related Question How can I get the javadoc of all methods with a specific Annotation, with the method name and package/class name? Intellij: Javadoc I can't see description of the methods, class in java documentation after ctrl+b How can I avoid semi-repeating groups of methods in java? How can I divide an arraylist of custom objects into groups of x based on the attributes of each object in the arraylist? Javadoc methods and inherited methods How can I dynamically assign test groups to test methods and @BeforeXXX and @AfterXXX annotated methods during runtime? can we make JavaDoc tool to parse comments inside methods? JavaDoc: private fields and methods JAVADOC for private methods (BlueJ) Grouping javadoc methods

Related Tags

JavaDoc - Can I divide methods into groups?

Question

3 answers

solution1
4 2016-03-15 19:35:13

solution2
2 2016-03-15 18:00:29

solution3
1 2018-05-15 16:59:02

JavaDoc - Can I divide methods into groups?

Question

3 answers

solution1 4 2016-03-15 19:35:13

solution2 2 2016-03-15 18:00:29

solution3 1 2018-05-15 16:59:02

solution1
4 2016-03-15 19:35:13

solution2
2 2016-03-15 18:00:29

solution3
1 2018-05-15 16:59:02