C++如何使用Doxygen生成代码文档？（自动化工具）

Doxygen是C++项目主流自动化文档工具，通过规范注释（如///、/**/）和配置文件生成多格式文档；需正确安装、配置INPUT/RECURSIVE等参数，使用@breif/@param等标签，并集成至CMake或CI流程。

Doxygen 是 C++ 项目最主流的自动化文档生成工具，它能从源码注释中提取结构化信息，生成 HTML、LaTeX、XML 等多种格式的文档。关键不在于写得多，而在于写得规范、位置对、标记准。

1. 安装与基础配置

Windows 可直接下载安装包（官网 doxygen.org），macOS 推荐 brew install doxygen，Linux 用包管理器如 apt install doxygen。安装后运行：

生成默认配置文件 Doxyfile。只需修改几项就能跑起来：

立即学习“C++免费学习笔记（深入）”；

• PROJECT_NAME = 你的项目名（如 "MyCppLib"）
• INPUT = 源码目录路径（支持空格分隔多个路径，如 src include）
• RECURSIVE = YES（递归扫描子目录）
• EXTRACT_ALL = YES（即使没写注释也提取符号，便于补全）
• GENERATE_HTML = YES（生成网页版，默认开启）

2. 在 C++ 代码中写 Doxygen 注释

Doxygen 不解析普通注释（// 或 /* */），必须用特定格式。常用三种风格：

• /// 行首三斜杠：用于函数、变量、类成员上方
• /** ... */ 块注释：适合多行说明，开头加两个星号
• //! 或 /*! ... */：常用于宏、全局变量等紧贴声明的场景

示例：

标签： linux html git windows github 浏览器 工具 mac c++ macos win gitla