如何用Doxygen解析Makefile及识别无扩展名文件注释？

1. 先给Doxygen配置文件加规则 #

打开你的Doxyfile，做这两处修改：

• 映射无扩展名文件到对应解析器：
  添加EXTENSION_MAPPING配置，把无扩展名文件分别关联到Makefile和Dockerfile的解析规则：

  EXTENSION_MAPPING = =Makefile
  EXTENSION_MAPPING += =Dockerfile
  

  这里第一个=代表无扩展名，后面指定对应的语言类型。
• 让Doxygen扫描无扩展名文件：
  在FILE_PATTERNS里加上*，确保Doxygen会处理无扩展名的Makefile和Dockerfile：

  FILE_PATTERNS += *
  

2. 调整注释格式让Doxygen认得出 #

Makefile注释写法 #

Makefile用#注释，只要加上Doxygen的标签就能被识别：

• 块注释（适合说明目标/变量）：

  ## @brief 编译项目的主目标
  ## @param BUILD_TYPE 可选Debug或Release，控制编译模式
  all:
      $(CC) $(CFLAGS) -o main src/*.c
  

• 单行注释（适合临时说明）：

  # @note 这里关闭了编译警告输出
  CFLAGS += -w
  

Dockerfile注释写法 #

Dockerfile同样用#，适配方式一致：

• 块注释（说明镜像构建步骤）：

  ## @brief 基于Python 3.10 slim镜像构建基础环境
  ## @details 这个镜像体积小，适合生产环境部署
  FROM python:3.10-slim
  
  ## @brief 设置工作目录并安装依赖
  WORKDIR /app
  COPY requirements.txt .
  RUN pip install --no-cache-dir -r requirements.txt
  

• 单行注释：

  # @warning 生产环境记得把DEBUG改成0
  ENV DEBUG=1
  

3. 验证效果 #

改完配置和注释后，运行Doxygen生成文档：

doxygen Doxyfile

打开生成的HTML文档，检查Makefile和Dockerfile的注释有没有被正确解析展示就行。

内容的提问来源于stack exchange，提问作者Gopiprasad Ravada