用于创建企业应用程序文档的Java工具

Question

这个问题有点模糊，但我想知道是否有一个可以运行我的代码并以功能方式记录它的Java工具。 JavaDoc是唯一可行的方法，还是有替代方案？

Answer 1

JavaDoc是生成参考文档的好方法。您可以使用自定义doclet使其适应您的需求（外观，功能或额外的铃声和哨声），但它仍然是一个方法及其描述的列表。

记录企业软件更多的是记录更高级别的东西，如设计信息，架构，组件交互等。没有我知道的软件工具会自动为你做这件事（逆向工程工具主要会产生一团糟），但是有许多内容管理系统可以帮助您更好地组织和呈现它。

您还可以编写一个JavaDoc替代方案（或使用现有的东西），它使用反射来分析类库并生成内容，可能需要您通过注释提供帮助。例如，有一些研究工具可以让您在代码中放置架构约束，然后用于一致性测试，也可能用于文档。

Answer 2

这一切都取决于你想要的生成文档。 JavaDoc是用Java编写API文档的标准方法，因此这可能是您最好的起点。如果您只需要调整输出，实际上有一个Doclet API。 Doclet API的一个实例是UMLGraph doclet，它可以在您的JavaDoc输出中嵌入UML图。

如果你只是讨厌JavaDoc，总会有像Doxygen这样的东西。