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

时间:2016-03-15 16:08:52

标签: java javadoc

我目前正在为具有许多功能的类创建文档。 有没有办法组织JavaDoc,以便概述中的方法分为几个类别?

3 个答案:

答案 0 :(得分:4)

也许尝试重构它,这样你就没有"很多功能"在一堂课内。 将代码划分为更易于维护,可读性,测试,调试,记录等的小部分要好得多。

答案 1 :(得分:2)

JavaDoc工具没有这样的功能。甚至JDK的方法也没有以这种方式分组。

答案 2 :(得分:1)

我担心它不是 Javadoc - 但 doxygen 支持在输出中对项目进行分组。

我使用doxygen优先于Javadoc进行个人项目,并使用专业的多语言项目。文档注释格式在很大程度上与Javadoc足够接近,但我发现它更丰富和可扩展,输出更好。

哎呀,对于一个项目,我们通过doxygen发布了用户指南和API指南PDF格式