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。安装后运行：
doxygen -g Doxyfile
生成默认配置文件 Doxyfile。只需修改几项就能跑起来：
立即学习“C++免费学习笔记（深入）”；
PROJECT_NAME = 你的项目名（如 “MyCppLib”）INPUT = 源码目录路径（支持空格分隔多个路径，如 src include）RECURSIVE = YES（递归扫描子目录）EXTRACT_ALL = YES（即使没写注释也提取符号，便于补全）GENERATE_HTML = YES（生成网页版，默认开启）
2. 在 C++ 代码中写 Doxygen 注释
Doxygen 不解析普通注释（// 或 /* */），必须用特定格式。常用三种风格：
/// 行首三斜杠：用于函数、变量、类成员上方/** … */ 块注释：适合多行说明，开头加两个星号//! 或 /*! … */：常用于宏、全局变量等紧贴声明的场景
示例：
/// @brief 计算两个整数的最大公约数
/// @param a 第一个正整数
/// @param b 第二个正整数
/// @return 最大公约数
int gcd(int a, int b);
3. 常用 Doxygen 标签（C++ 场景重点）
标签让文档结构清晰、可跳转、带语义。C++ 开发中高频使用这些：
@brief：简短概述（必填，出现在列表页）@param [name]：参数说明（name 必须与函数声明一致）@return 或 @returns：返回值描述@see：关联其他函数/类（支持 @see MyClass::func()）@note / @warning / @deprecated：标注注意事项、风险或弃用状态@ingroup：归组（需配合 MODULES 配置，适合模块化文档）
4. 一键生成 + 集成到工作流
执行命令即可生成文档：
doxygen Doxyfile
输出默认在 html/ 目录，用浏览器打开 index.html 即可浏览。推荐进一步集成：
加到 CMakeLists.txt 中：用 find_package(Doxygen) + add_custom_target(doc ...)，运行 make doc 即可CI/CD 中自动构建：GitHub Actions 或 GitLab CI 加一步 doxygen，上传 HTML 到 Pages 或对象存储配合 DOT_PATH 和 HAVE_DOT = YES 可生成类图、调用图（需 Graphviz）
基本上就这些。不复杂但容易忽略的是：注释要贴近声明、标签拼写不能错、配置里 INPUT 路径别漏头文件。坚持写，文档就自然跟上了。
以上就是C++如何使用Doxygen生成代码文档？（自动化工具）的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1489025.html
微信扫一扫 
支付宝扫一扫 
