使用Doxygen可从C++代码注释中自动生成HTML、PDF等格式文档，提升项目可维护性。首先安装Doxygen，运行doxygen -g生成配置文件Doxyfile，修改输入路径、项目名等参数。在代码中采用/**或///风格注释，使用@brief、@param、@return等标签描述类、函数及参数。配置完成后运行doxygen Doxyfile，生成的文档默认输出至html目录，可用浏览器查看。通过设置OUTPUT_FORMAT = PDF可生成PDF文档，结合@see、@code等标签增强文档可读性，定期更新注释确保与代码同步，从而高效构建高质量技术文档。
写代码时顺手生成清晰的文档，能极大提升项目可维护性和团队协作效率。Doxygen 是一个强大的工具，能够从 C++ 源码中提取注释并自动生成结构化的文档。只要在代码中使用规范的注释格式，就能轻松输出 HTML、LaTeX、PDF 等多种格式的说明文档。
配置 Doxygen 生成文档环境
首先确保系统中已安装 Doxygen。大多数 Linux 发行版可通过包管理器安装：
sudo apt install doxygen
macOS 用户可用 Homebrew：
brew install doxygen
Windows 用户可从官网下载安装包。安装完成后，进入项目根目录运行：
立即学习“C++免费学习笔记（深入）”；
doxygen -g
这条命令会生成默认的 Doxyfile 配置文件。你可以根据需要修改输出格式、项目名称、源码路径等参数。
编写符合 Doxygen 规范的注释
Doxygen 能识别多种注释风格，最常用的是以 /** 或 /// 开头的注释块。例如，为一个类添加说明：
/**
* @brief 表示一个二维点的类
*
* 该类用于存储和操作平面中的坐标点，
* 支持基本的算术运算和距离计算。
*/
class Point {
public:
double x, y;
/**
* @brief 构造函数，初始化坐标
* @param x_val X 坐标值
* @param y_val Y 坐标值
*/
Point(double x_val, double y_val);
/**
* @brief 计算到另一点的距离
* @param other 另一个点对象
* @return 双精度浮点数，表示欧几里得距离
*/
double distance(const Point& other) const;
};
使用 @brief 定义简要说明，@param 描述参数，@return 说明返回值。这些标签会被 Doxygen 自动解析并组织成表格形式。
生成并查看文档
配置好注释后，在项目目录下运行：
doxygen Doxyfile
默认情况下，文档会生成在 html 目录中。用浏览器打开 index.html 即可查看完整的 API 文档。你也可以在配置文件中设置 OUTPUT_FORMAT = PDF 来生成 PDF 文档（需配合 LaTeX）。
如果希望只对特定目录生成文档，可在 Doxyfile 中设置：
INPUT = ./src ./include RECURSIVE = YES
提升文档质量的小技巧
- 保持注释简洁但完整，重点说明“做什么”而非“怎么做”
- 为公共接口添加详细说明，私有成员可简化或忽略
- 使用 @see 添加相关类或函数的链接
- 用 @code ... @endcode 包裹代码示例，增强可读性
- 定期更新注释，避免与代码实现脱节
基本上就这些。只要养成写规范注释的习惯，Doxygen 就能帮你把代码变成专业文档，省时又高效。
