java - Doxygen 与 Javadoc

标签 java maven-2 documentation doxygen

我刚刚从 CACM 的一篇文章中了解到,Doxygen 也可以与 Java(和其他几种语言)一起使用。但是Java 已经有了Javadoc 工具。有人可以解释这两种方法的优缺点吗?它们是相互排斥的吗?有 Doxygen 的 Maven 插件吗?

最佳答案

Doxygen 有许多 JavaDoc 不提供的特性,例如层次结构和合作上下文的类图,更多摘要页面,可选的源代码浏览(与文档交叉链接),额外的标签支持,例如单独页面上的@todo,它可以生成 TeX 和 PDF 格式的输出.它还允许大量的视觉定制。

由于 Doxygen 支持标准的 JavaDoc 标签,您可以在任何带有 JavaDoc 注释的源代码上运行 Doxygen。在没有 JavaDoc 的情况下在源代码上运行通常甚至是有意义的,因为图表和源代码浏览可以帮助理解代码,即使没有文档。由于 JavaDoc 工具会忽略未知标签,因此您甚至可以使用额外的 Doxygen 标签而不会破坏 JavaDoc 的生成。

说了这么多,我必须承认我已经很久没有使用 Doxygen 了。现在我倾向于严重依赖我的 IDE 来提供相同的可视化,我通常不会将 JavaDoc 当作 HTML 页面来阅读,而是将源文件导入我的 IDE,以便它可以生成 JavaDoc 弹出窗口,我可以跳转到定义。这比 Doxygen 提供的功能更强大。如果您想在 IDE 之外拥有文档并且乐于运行非 Java 工具,那么 Doxygen 值得一试,因为它不需要对您的 Java 代码进行任何更改。

关于java - Doxygen 与 Javadoc,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/225447/

相关文章:

Java文档

delphi - 未记录的内在例程

swift - 如何在 XCode 中记录参数标签而不是 Swift 函数的参数名称?

java - Jersey ResourceConfig 不会自动发现但应用程序会自动发现吗?

java - 澄清 HashMap 中的 @ConcurrentModificationException

java - 测试图灵机仿真程序

maven-2 - mvn :deploy and mvn:install commands? 和有什么区别

java - Spring - 在每次调用 Service/DAO 层时包含当前用户

maven-2 - aar 文件未添加到 war axis2-aar-maven-plugin 中

maven-2 - 寻找新版本的依赖