doxygen python配置

喜爱波波奶茶2026-05-23 13:25

生成配置文件

复制代码

doxygen -g doxygen.conf

修改配置文件

ini 复制代码

# 设置工程名称
PROJECT_NAME = "Your Project"
# 指定源码目录
INPUT = ./src  
# 包含 Python 文件
FILE_PATTERNS = *.py  
# 启用 Python 优化输出
OPTIMIZE_OUTPUT_FOR_PYTHON = YES  
# 使用 doxypypy 转换文档字符串
# FILTER_PATTERNS = "*.py=doxypypy"  可以不使用这个 使用下面这个
PYTHON_DOCSTRING = NO
# 生成 HTML 文档（默认格式）
GENERATE_HTML = YES  

EXTENSION_MAPPING      = py=Python

生成 htm 文件

复制代码

doxygen doxygen.conf

Doxygen 常用关键字

perl 复制代码

/**
    *
    * @file 档案的批注说明
    * @author 作者的信息
    * @see 参考项 http://www.cnblogs.com/tianzhijiexian/
    * @brief 求和
    * @author QXT
    * @date 2016/10/13 13:37:56
    * @version 0.1
    * @retval c 描述返回值的类型
    * @note 注解，可以是详细的注解
    * @remarks   备注事项（remaks）
    * @attention 注意事项(attention)
    * @warning 警告信息
    * @param a 用来相加的参数
    * @param b 用来相加的参数
    * @return 传回两个参数相加的结果
    *
    */
int AddFun（int a,int b）{undefined
    return (a+b);
                          }