python - 使用 Doxygen 记录 UTF-8 Python 代码

标签 python utf-8 doxygen

doxygen 无法正确解析以下代码,生成的文档中未显示“模块文档字符串”:

# -*- coding: utf-8 -*-
"""
Module Docstring
"""

如果我删除第一行,它就会被正确解析。但我需要设置编码,因为我在代码中使用非 ASCII 字符。有人遇到同样的问题吗? 我尝试使用 doxypy,但也失败了。还尝试了配置文件中的许多不同更改。

到目前为止,最好的办法是对某种脚本使用 INPUT_FILTER 参数来删除第一行,也许使用“tail -n +3”作为过滤器。问题在于,并非每个文件都需要“编码:utf-8”,因此将其放入每个文件中将是一件痛苦的事情。还有更好的想法吗?我是否忽略了什么?

最佳答案

您可以指定输入编码配置变量:

http://www.doxygen.nl/manual/config.html#cfg_input_encoding

该变量应设置为 UTF-8(全部大写,需要连字符,无空格),如 http://www.gnu.org/software/libiconv/ 中指定。

希望这有帮助。快乐的记录:-)

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

相关文章:

Python/postgres/psycopg2 : getting ID of row just inserted

python - 如何将变量传递给 re.sub 回调?

python - 使用 Python 在 POST 请求中从 PIL Image 发送多个 StringIO

sql-server - 将 UTF8 字符串插入 SQL Server 2008 表时出现 SQL 错误

javascript - JS 编码解码 UTF 的问题?

c++ - doxygen 生成供机器读取的文档

c - Doxygen:记录函数指针类型的参数 (ANSI-C)

python - 通过 Google Cloud SDK 更新后无法启动 App Engine 应用程序

php - UTF-8贯穿始终

c++ - 在 Doxygen 中记录回调类型定义