首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >Doxygen vs Javadoc

Doxygen vs Javadoc
EN

Stack Overflow用户
提问于 2008-10-22 11:54:37
回答 4查看 37.4K关注 0票数 67

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

EN

回答 4

Stack Overflow用户

回答已采纳

发布于 2008-11-27 12:51:13

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

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

说了这么多,我必须承认我已经很长时间没有使用Doxygen了。现在我倾向于依赖集成开发环境来提供相同的可视化效果,而且我通常不会将JavaDoc作为超文本标记语言页面读取,而是将源文件导入到集成开发环境中,这样它就可以生成JavaDoc弹出按钮,然后我就可以跳转到定义。这甚至比Doxygen提供的功能更强大。如果您希望在IDE之外拥有文档,并且乐于运行非Java工具,那么Doxygen值得一试,因为它不需要对Java代码进行任何更改。

票数 76
EN

Stack Overflow用户

发布于 2008-10-22 12:07:45

如果您是Java新手,并且以前使用过Doxygen,那么我只会在Java中使用Doxygen,这将减少您在使用javadoc时所经历的学习曲线。如果您以前没有使用过Doxygen,我将继续使用javadoc,因为它是专门为Java而设计的。如果您对这两种语言都不了解,并且使用C++ (或其他受支持的语言)的时间和使用Java语言的时间一样多,那么Doxygen是一个很好的选择,因为您可以在这两种语言中使用它。

这两个工具都很容易使用,具有相似的功能集。它们都有用于NetBeans和Eclipse的插件(或者是预置的),这使得生成文档的速度更快。它们使用的注释样式有很多重叠之处,但它们并不完全相同,因此很难将它们混合在一起(您必须了解两者的详细信息,省略任何特定于其中一个的特性)。我从来没有用过它,但似乎确实有一个Maven plugin for Doxygen

票数 18
EN

Stack Overflow用户

发布于 2008-10-22 12:24:39

我喜欢的事实是,使用Doxygen,您可以将类图显示在与文档相同的页面上。此外,如果需要,我喜欢它直接链接到源代码的事实。我不知道javadoc是否有这些特性。

票数 4
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/225447

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档