VS（2019 2022）中使用Doxygen 详解

在 Visual Studio (VS) 中使用 Doxygen 可以帮助你自动生成 C++ 项目的 API 文档，包括类结构、函数说明、继承关系等。以下是从安装、注释写法到生成 HTML 文档的完整流程详解：

---

一、准备工作

1. 安装 Doxygen

• 官网下载：https://www.doxygen.nl/download.html
• Windows 用户建议同时勾选安装 Graphviz（生成类图）

2. 安装 Graphviz（可选但推荐）

• 下载：https://graphviz.org/download/
• 安装后将其 bin 路径添加到系统环境变量 Path 中（如 C:\Program Files\Graphviz\bin）

---

二、创建配置文件

方式 1：命令行创建

doxygen -g Doxyfile

方式 2：图形界面（推荐）

1. 打开 Doxywizard

2. 设置输入路径（源码目录）和输出路径（HTML 文档输出目录）

3. 勾选：

   • Extract all
   • Source browser
   • Have dot tool（使用 Graphviz 生成图）

4. 保存配置文件 → 点击【Run】运行

---

三、在代码中写 Doxygen 注释

类注释示例：

/**
 * @class MyClass
 * @brief 这是一个示例类
 */
class MyClass {
public:
    /**
     * @brief 构造函数
     * @param value 初始值
     */
    MyClass(int value);

    /**
     * @brief 获取值
     * @return 当前值
     */
    int getValue() const;

private:
    int value_;
};

注释关键标签：

标签	说明
@brief	简要说明
@param	函数参数说明
@return	返回值说明
@author	作者
@version	版本
@see	参考
@note	备注

---

四、在 Visual Studio 中集成使用

方法一：外部工具绑定 Doxygen

1. 打开 VS → 工具 → 外部工具

2. 添加一个新项：

   • 标题：Run Doxygen
   • 命令：C:\Program Files\doxygen\bin\doxygen.exe
   • 参数：$(SolutionDir)Doxyfile
   • 初始目录：$(SolutionDir)

3. 在解决方案中添加 Doxyfile 文件到项目根目录

之后可在工具栏点击“Run Doxygen”运行文档生成。

方法二：生成文档脚本

你可以编写一个 generate_docs.bat 批处理脚本放在工程目录中：

@echo off
doxygen Doxyfile
pause

---

五、查看输出文档

默认输出在 html/index.html，用浏览器打开即可查看完整的类文档和函数文档。

---

六、使用建议

• 注释尽量写在声明上方（而非实现处），方便 Doxygen 提取。
• 支持 Markdown，比如 **加粗**, - 列表, \code...\endcode
• 每个类建议都写上 @brief 和作者、版本等信息。

---

示例项目结构

MyProject/
├── src/
│   └── my_class.cpp
├── include/
│   └── my_class.h
├── Doxyfile
├── generate_docs.bat
└── html/   <- 生成文档