使用 Doxygen 为 python 脚本生成文档答案

【问题标题】：Generating documentation for python script with Doxygen使用 Doxygen 为 python 脚本生成文档
【发布时间】：2016-11-21 12:27:56
【问题描述】：

我正在尝试为我的项目中包含的一些 Python 脚本创建一些文档（其余的是 Fortran/C）。我设法对文件进行了简要和详细的描述，但是脚本中定义的所有变量都列在了文档中。

如何避免它们被列出？ Doxyfile 中的哪个变量控制文件中所有变量的包含？

【问题讨论】：

你是如何为你的 Python 文件设置 Doxygen 的？你的 Python 文件有哪些细节？你所有的变量都是全局的吗？你是否在使用像 doxypypy 这样的用于 Python 的 Doxygen 过滤器？
我的 Python 文件只是应该从命令行以交互方式启动的脚本，动态声明全局变量（因此在我的 doxygen 文档中，我得到了为第一次）。是的，我正在使用 doxypy。

【解决方案1】：

我在使用 python-Doxygen 时遇到了类似的问题。对我有用的是将变量包含在 \cond 和 \endcond 之间。

例如，

## \cond
some_var = "abc"
## \endcond

它们不会出现在您的文档中 :)

【讨论】：