python - 使用 Doxygen 的 Qt 风格文档?

标签 python documentation doxygen

<分区>

如何使用 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 文档?

最佳答案

然后就用Doxygen? This will get you started :

This is a guide for automatically generating documentation off of Python source code using Doxygen.

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

关于python - 使用 Doxygen 的 Qt 风格文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/776388/

相关文章:

visual-studio-2008 - 在Visual Studio 2008中自定义XML注释

line - 在 doxygen 文档中如何创建指向文件特定行的链接

python - 如何增加azure oauth token 的过期时间?

python - 对表单更改使用react

documentation - 在 Doxygen 中,如何通过示例代码中的函数名称而不是标签来包含片段

javascript - 将 JsDoc3 用于大型应用程序,如何将模块分组到部分/类别/子模块中

c++ - 如何使用 doxygen 将多个方法分组到一个类中?

documentation - 问题让 Doxygen 在 C 中记录枚举

python - 通过 PyRFC 在 RFC_READ_TABLE 调用中打开 SQL 条件

python - 类型错误 : object of type 'IMapIterator' has no len() for pool. imap