python - 使用 Doxygen 的 Qt 样式文档？

Question

如何使用 Doxygen 生成 Qt 风格的文档（Trolltech 的 C++ Qt 或 Riverbank 的 PyQt 文档）？我正在记录 Python，我希望能够改进它产生的默认函数简介。

特别是，我希望能够看到函数简介中的返回类型（可以是用户指定的）和参数。

例如：

 Functions:

     int getNumber(self)
     str getString(self)
     tuple getTuple(self, int numberOfElements=2)

 Function Documentation:

     int getNumber(self)

           gets the number of items within a list as specified...

           Definition at line 63 of ....

     etc...

如果不修改源代码就无法做到这一点，那么除了 Doxygen 之外，也许还有其他工具可以以这种方式处理 Python 文档？

Answer 1

然后只使用Doxygen？这将使您入门：

这是使用 Doxygen 从 Python 源代码自动生成文档的指南。

显然，由于 Python 不是强类型的，因此指定参数的返回类型和预期类型将取决于您，文档编写者。无论如何，这只是最佳实践。

Answer 2

如果你在做任何与 Python 相关的文档，我推荐Sphinx。这是 python 的开发人员在他们的文档中使用的。

Answer 3

此页面似乎详细介绍了创建 qt 样式文档的方法。
基本上有一个你用 qt 调用的工具，qhelpgenerator它创建一个.qch文件，可由 qt 助手食用。
我以前没有使用过它，但它看起来相当简单。

Answer 4

您不必在代码中添加 doxygen 注释。您可以将文档放在其他地方。在 doxygen 手册中查看此页面。