Doxygen 1.9.1版本Python函数文档字符串格式化异常求助
Doxygen 1.9.1 文档字符串格式化异常问题处理
不少用户都碰到过Doxygen 1.9.1这个版本的这个问题——Python风格的文档字符串里,首行之后的内容被误识别成代码块,导致@param这类关键字失效。
核心原因是1.9.1版本对文档字符串的缩进处理逻辑改了,只要后续行的缩进和首行不一致,就会被当成代码块解析。
给你几个可行的解决办法:
- 统一缩进:把文档字符串内所有行的缩进调整成和首行完全一致,比如示例代码改成这样:
"""!Figure with the delays between source images and the composites. @param output_img name of the output file @param df_composites DataFrame with the composites database """ - 修改配置:在Doxygen的配置文件里把
PYTHON_DOCSTRING设为NO,强制用Doxygen原生注释规则解析,但这样会失去Python文档字符串的部分原生支持。 - 版本回退:暂时换回之前能用的旧版本(比如1.8.x系列),等官方修复这个缩进识别的bug。
内容的提问来源于stack exchange,提问作者Pythonist
相关产品推荐
相关产品推荐

