python - 如何让 doxygen 忽略 Python 脚本的第一行？

Question

我在 Doxygen 完美解析的 Python 脚本的开头有一个文档字符串。但是，如果我#!/usr/bin/env python在文件的开头添加（以使脚本可执行），则 Doxygen 无法识别整个文档字符串。

那么，我怎样才能让 Doxygen 忽略第一行呢？

工作文档字符串的示例：

"""@package HelloWorld
This is a docstring and it's recognized by doxygen."""

非工作文档字符串的示例：

#!/usr/bin/env python
"""@package HelloWorld
This is a docstring and it's not recognized by doxygen because of the first line."""

谢谢！

Answer 1

好的，我找到了：我需要先使用解析器。我尝试了 doxypy并且效果非常好。您只需在 doxy_conf 文件中进行以下更改：

FILTER_SOURCE_FILES = YES
INPUT_FILTER = "python path/to/doxypy.py"