C++项目Doxygen注释编写与自动生成指南
Doxygen注释重在结构化标记而非堆砌文字，需用@param、@return等命令准确标注函数签名与语义；类成员注释必须置于头文件声明行上方，否则无法索引和解析继承关系。
Doxygen注释重在结构化标记而非堆砌文字，需用@param、@return等命令准确标注函数签名与语义；类成员注释必须置于头文件声明行上方，否则无法索引和解析继承关系。
Doxygen 注释不是“写得越多越好”，而是要让 doxygen 能准确提取符号语义、关联关系和调用上下文——关键在结构化标记，不在段落堆砌。
用对 Doxygen 命令标记函数签名与参数
函数文档必须显式声明参数、返回值、异常，否则生成的 HTML 中参数表为空、@return 不出现，且 IDE（如 VS Code + Doxygen Documentation Generator）无法补全提示。
常见错误是只写自然语言描述，漏掉命令标记：
/** * @brief 计算两个整数的最大公约数 * @param a 第一个整数 * @param b 第二个整数 * @return 非负整数，即 gcd(a, b) * @throw std::invalid_argument 当 a 和 b 均为 0 时抛出 */ int gcd(int a, int b);
注意：@brief 后必须换行或加空格再写正文；@param 名称必须与函数声明中完全一致（区分大小写）；@throw 的异常类型应与 noexcept 声明或实际 throw 语句匹配。
类成员注释要绑定到声明行，而非定义行
Doxygen 默认按源码位置解析，把注释写在 .cpp 文件里的函数定义上方，会导致类成员（尤其是 private 成员）不被索引，继承关系断裂。
正确做法是：所有类声明（含 public/protected/private 区块内）的成员注释，必须紧贴其在 .h 文件中的声明行上方：
class Buffer {
public:
/**
* @brief 构造指定容量的缓冲区
* @param capacity 缓冲区字节数，必须 > 0
*/
explicit Buffer(size_t capacity);
private:
char* data_; ///< 堆分配的原始内存指针
sizet capacity; ///< 总容量（字节）
};
其中 ///< 是行尾注释语法，适用于简单字段说明；复杂字段（如模板参数、生命周期约束）仍建议用块注释 + @brief。
避免 @file 和 @defgroup 误用导致模块混乱
很多项目在每个 .h 顶部加 @file，结果生成文档时所有文件挤在同一个“Files”页，失去模块划分意义。真正需要的是逻辑分组。
推荐做法：
- 在主头文件（如
core.hpp）顶部用@defgroup core Core Library定义模块 - 在同模块其他头文件顶部用
@ingroup core归属，而非重复@defgroup @file仅用于无对应模块的独立工具文件（如build_info.hpp），且需配@brief
若使用 @mainpage，务必放在单独的 mainpage.dox 中，并在 Doxyfile 中通过 INPUT += mainpage.dox 显式引入——否则 doxygen 会忽略它。
配置 Doxyfile 时重点打开这三项
默认配置下，Doxygen 会跳过未显式注释的符号，且不解析模板实例化。要生成完整 API 文档，必须手动开启：
EXTRACT_ALL = YES：保证所有声明（即使没加注释）也出现在文档中，作为占位参考EXTRACT_STATIC = YES：导出static成员函数/变量，否则它们不会出现在类页面里TEMPLATE_RELATIONS = YES：启用模板特化关系图（如std::vector指向std::vector基模板）
另外，RECURSIVE = YES 和 INCLUDE_PATH 必须设对，否则 @include 或 @ref 跨目录链接会失败；路径一律用正斜杠（/），Windows 下也别用反斜杠。
最易被忽略的一点：Doxygen 不解析预处理器宏展开后的代码。如果接口大量依赖 MACRO(int foo) 这类包装，必须在宏定义处加注释，或改用 @copydoc 引用原始声明——否则生成的文档里只会显示宏名，没有参数和返回值。
正软商城本月促销专区，汇集办公、设计、安全、影音、系统工具及AI软件等正版软件优惠活动，提供限时折扣、特价授权和优惠购买信息，活动库存及价格以页面实时展示为准。
正软商城装机必备专区，精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件，帮助用户快速完成新电脑软件配置。
正软商城Windows软件专区，汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件，提供软件介绍、系统要求、正版授权及购买下载服务。
正软商城macOS软件专区，精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具，提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。
正软商城iOS软件专区，精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用，提供功能介绍、适用设备、系统要求和正版获取方式等信息。
正软商城AI软件专区，汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具，提供功能介绍、适用平台、收费方式及正版购买信息。
正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法，同时介绍常用PDF软件和工具的使用技巧。
赤友清理大师是一款为 Mac 设计的智能清理优化工具，可精准扫描垃圾、大文件、重复文件等，释放磁盘空间。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
极度公式是一款跨平台专业LaTeX公式识别编辑软件，支持OCR公式识别和多平台编辑。和使用说明，避免使用，享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
一款文字处理软件，一种订阅式的跨平台办公软件，基于云平台提供多种服务，通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合，Office 365 可让任何人使用任何设备随时随地创建和共享内容。
CodeExpander 是一款快捷短语输入增强工具，通过键入缩写自动展开为自定义文段，提升工作效率。任务管理和过程控制会更完整，持续下载、批量同步或需要稳定传输流程的场景会更适合它。
Mountain Duck 是一款能将多个网盘挂载到本地的工具，像本地磁盘一样使用网盘。清理链路的完整性会更好一些，做应用卸载、残留处理和空间整理时，通常能少走很多手动排查步骤。
极度公式是一款跨平台专业LaTeX公式识别编辑软件，支持OCR公式识别和多平台编辑。和使用说明，避免使用，享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时，它能把识别后的处理步骤接得更顺，资料录入这类场景会省下不少时间。
一款文字处理软件，一种订阅式的跨平台办公软件，基于云平台提供多种服务，通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合，Office 365 可让任何人使用任何设备随时随地创建和共享内容。
Wise Folder Hider Pro 是一款专业级文件和文件夹隐藏加密软件，为私密数据添加多重保护。高频操作更强调就近处理，浏览、整理和跨目录移动文件时，来回切换和重复点击都会少很多。
CodeExpander 是一款快捷短语输入增强工具，通过键入缩写自动展开为自定义文段，提升工作效率。任务管理和过程控制会更完整，持续下载、批量同步或需要稳定传输流程的场景会更适合它。
Mountain Duck 是一款能将多个网盘挂载到本地的工具，像本地磁盘一样使用网盘。清理链路的完整性会更好一些，做应用卸载、残留处理和空间整理时，通常能少走很多手动排查步骤。
