当前位置: 首页 > 面试题库 >

Doxygen vs Javadoc

龙凯
2023-03-14
问题内容

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


问题答案:

Doxygen具有JavaDoc不提供的许多功能,例如,层次结构和合作上下文的类图,更多摘要页面,可选的源代码浏览(与文档交叉链接),附加的标签支持,例如@todo
on一个单独的页面,它可以生成TeX和PDF格式的输出,还可以进行很多视觉定制。

由于Doxygen支持标准JavaDoc标记,因此您可以在带有JavaDoc注释的任何源代码上运行Doxygen。在没有JavaDoc的情况下,甚至可以在源代码上运行,因为即使没有文档,图表和源代码浏览也可以帮助理解代码。而且由于JavaDoc工具会忽略未知标签,因此您甚至可以使用其他Doxygen标签,而不会中断JavaDoc的生成。

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



 类似资料:

相关阅读

相关文章

相关问答