简体繁体 English

JavaDoc - 我可以将方法分成组吗？

[英]JavaDoc - Can I divide methods into groups?

原文 2016-03-15 16:08:51 6 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? 有没有办法组织JavaDoc，以便概述中的方法分为几个类别？

3 个解决方案

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. JavaDoc工具没有这样的功能。 Even the JDK's methods aren't grouped in such a fashion. 甚至JDK的方法也没有以这种方式分组。

I am afraid its not Javadoc - but doxygen supports grouping items in the output. 我担心它不是Javadoc - 但是doxygen支持在输出中对项目进行分组。

I've used doxygen in preference to Javadoc for personal projects, and for multi-language projects professionally. 我使用doxygen而不是Javadoc用于个人项目，以及专业用于多语言项目。 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. 文档注释格式在很大程度上与Javadoc足够接近，但我发现它更丰富和可扩展，输出更好。

Heck, for one project we published the Users Guide and API Guide as PDF through doxygen... 哎呀，对于一个项目，我们通过doxygen发布了用户指南和API指南作为PDF ...

如何使用特定的Annotation获取所有方法的javadoc，方法名称和包/类名？ - How can I get the javadoc of all methods with a specific Annotation, with the method name and package/class name?

Intellij：Javadoc 在 ctrl+b 后我看不到方法的描述，class 在 java 文档中 - Intellij: Javadoc I can't see description of the methods, class in java documentation after ctrl+b

如何避免在Java中半重复方法组？ - How can I avoid semi-repeating groups of methods in java?

如何根据数组列表中每个对象的属性将自定义对象的数组列表分成 x 组？ - How can I divide an arraylist of custom objects into groups of x based on the attributes of each object in the arraylist?

Javadoc方法和继承的方法 - Javadoc methods and inherited methods

如何在运行时将测试组动态分配给测试方法和@BeforeXXX 和@AfterXXX 注释方法？ - How can I dynamically assign test groups to test methods and @BeforeXXX and @AfterXXX annotated methods during runtime?

我们可以制作 JavaDoc 工具来解析方法内的注释吗？ - can we make JavaDoc tool to parse comments inside methods?

JavaDoc：私有字段和方法 - JavaDoc: private fields and methods

私有方法的JAVADOC（BlueJ） - JAVADOC for private methods (BlueJ)

分组javadoc方法 - Grouping javadoc methods

暂无

暂无

声明:本站的技术帖子网页，遵循CC BY-SA 4.0协议，如果您需要转载，请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

相关问题 如何使用特定的Annotation获取所有方法的javadoc，方法名称和包/类名？ - How can I get the javadoc of all methods with a specific Annotation, with the method name and package/class name? Intellij：Javadoc 在 ctrl+b 后我看不到方法的描述，class 在 java 文档中 - Intellij: Javadoc I can't see description of the methods, class in java documentation after ctrl+b 如何避免在Java中半重复方法组？ - How can I avoid semi-repeating groups of methods in java? 如何根据数组列表中每个对象的属性将自定义对象的数组列表分成 x 组？ - How can I divide an arraylist of custom objects into groups of x based on the attributes of each object in the arraylist? Javadoc方法和继承的方法 - Javadoc methods and inherited methods 如何在运行时将测试组动态分配给测试方法和@BeforeXXX 和@AfterXXX 注释方法？ - How can I dynamically assign test groups to test methods and @BeforeXXX and @AfterXXX annotated methods during runtime? 我们可以制作 JavaDoc 工具来解析方法内的注释吗？ - can we make JavaDoc tool to parse comments inside methods? JavaDoc：私有字段和方法 - JavaDoc: private fields and methods 私有方法的JAVADOC（BlueJ） - JAVADOC for private methods (BlueJ) 分组javadoc方法 - Grouping javadoc methods

相关标签

粤ICP备18138465号 © 2020-2024 STACKOOM.COM