问题标签 [doxygen]

我喜欢用 Doxygen 创建 C 或 PHP 代码的文档。我有一个即将到来的 Python 项目，我想我记得 Python 没有/* .. */注释，并且还有自己的自我文档工具，这似乎是 Python 的文档方式。

由于我熟悉 Doxygen，如何使用它来生成 Python 文档？有什么特别需要我注意的吗？

如何配置 DoxyGen 以记录 ActionScript 文件？

我已经在 doxygen 的搜索模式中包含了 *.as 和 *.asi 文件，但是类、函数和变量并没有显示在那里。

Doxygen 有点慢 - 处理我的整个项目大约需要几分钟，所以对于小的增量更改，这比实际构建我的其余代码要长。有成千上万个文件没有任何文档，所以我猜它大部分时间都在处理它们。有没有办法让它在没有任何文档的情况下跳过文件？

让它只处理更改的文件怎么样？

我有一些带有模板的 C++ 源代码可能是这样的 - doxygen 运行时没有错误，但没有任何文档被添加到输出中，这是怎么回事？

我正在为每个构建的（相当小的）项目生成 doxygen 文档。我做了以下事情来做到这一点：

1. 在项目中添加了index.htmldoxygen 生成的 .
2. 为此文件指定了一个自定义构建步骤（不是整个项目）
   • 命令行：doxygen ../doc/Doxyfile
   • 输出：..doc/html/index.html
   • 附加依赖项：'../bin/foo.exe'

问题是，我需要构建两次，直到 VS 停止告诉我我的项目已过时。
我怎样才能解决这个问题？

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

我想使用 Doxygen 来记录混合了 C 和 x86 汇编语言的遗留代码。汇编语言不是内联的，而是在单独的仅汇编文件中。如何记录汇编语言部分？

我注意到 doxygen 使用 graphviz 库来创建图表。你曾经使用过 graphviz 来生成文档吗？出于 doxygen 范围之外的文档目的而学习 graphviz 是否值得？还是我最好坚持使用像 Visio 这样的标准数据建模包？

我理解它作为图形库的优点，但是为了尝试表示更复杂的 UML（或类似的），它仍然值得研究吗？

常识告诉 Doxygen 注释块必须放在类、结构、枚举、函数、声明所在的头文件中。我同意这是一个合理的论点，因为库的意思是在没有源代码的情况下分发（只有标头和带有目标代码的库）。

但是......当我开发公司内部（或作为我自己的副项目）库时，我一直在考虑完全相反的方法，该库将与其完整源代码一起使用。我建议将大的注释块放在实现文件（HPP、INL、CPP 等）中，以免弄乱标头中声明的类和函数的接口。

优点：

• 头文件中的混乱更少，只能添加功能的分类。
• 例如，使用 Intellisense 时预览的注释块不会发生冲突 - 这是我在 .H 文件中有函数的注释块并且在同一个 .H 文件中有其内联定义时观察到的缺陷但包含在 .INL 文件中。

缺点：

• （显而易见的）注释块不在声明所在的头文件中。

那么，您有什么想法和可能的建议？

如何使用 Doxygen 将 HTML 文档创建为单个非常长的文件？我想要类似 RTF 输出的东西，但作为 HTML。

原因：我需要将我的 API 作为单个可打印文档发布。可以加载到 Word 中、转换为 PDF 等的东西。