python - 如何使用 Doxygen 记录 Python 代码

标签 python documentation python-sphinx doxygen docstring

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

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

最佳答案

doxypy输入过滤器允许您以标准 Python 文档字符串格式使用几乎所有 Doxygen 的格式化标签。我用它来记录一个大型的混合 C++ 和 Python 游戏应用程序框架,它运行良好。

关于python - 如何使用 Doxygen 记录 Python 代码,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/58622/

相关文章:

python - imaplib/gmail 如何在不标记已读的情况下下载完整邮件(所有部分)

python - 写入文件时出现 UnicodeEncodeError

RESTful API 文档

ruby - 是否有 Ruby 语法的权威引用文档?

documentation - 如何解读软件和语言文档中的函数参数?

html - RestructuredText - 为链接添加标题属性

python - PyDict_SetItemString 段错误

python - 找到 1s 的最大矩形

python - Sphinx 没有正确更新文档

python - 在 Sphinx 文档中保留包装/修饰的 Python 函数的默认参数