首先安装Doxygen并配置环境变量，再通过Package Control安装DoxyDoxygen插件，接着设置注释风格与自动填充参数，在函数前输入/**并回车即可自动生成结构化注释，支持多语言且可自定义模板，提升代码文档化效率。
sublime Text 可以通过插件和外部工具集成 Doxygen，实现一键生成符合规范的文档注释。以下是如何在 Sublime 中配置并使用 Doxygen 自动生成代码注释的完整教程。
1. 安装 Doxygen 工具
Doxygen 是一个文档生成系统，支持 C/C++、java、python 等多种语言。首先需要在系统中安装它：
- windows： 下载并安装 Doxygen Windows 安装包，安装后确保将
doxygen添加到系统环境变量 PATH 中。 - macos： 使用 Homebrew 安装：
brew install doxygen - linux： 使用包管理器，如 ubuntu 上执行：
sudo apt-get install doxygen
安装完成后，在终端或命令行输入 doxygen -v 验证是否安装成功。
2. 安装 Sublime 插件：DoxyDoxygen
DoxyDoxygen 是 sublime text 中最常用的 Doxygen 注释生成插件，支持自动补全函数、类、参数等注释内容。
安装步骤：
- 确保已安装 Package Control（Sublime 的插件管理工具）
- 按下
Ctrl+Shift+P（Windows/Linux）或Cmd+Shift+P（Mac）打开命令面板 - 输入 “Install Package”，选择对应选项
- 搜索 “DoxyDoxygen”，点击安装
3. 配置 DoxyDoxygen 插件
安装完成后，可进行简单配置以适配你的开发习惯：
- 进入菜单栏：Preferences → Package Settings → DoxyDoxygen
- 可修改注释风格（如 qt、JavaDoc、C# 等），默认支持 Doxygen 标准格式
- 建议启用自动添加函数参数和返回值描述，在设置中确认
"auto_fill": true
例如，当光标放在函数上方，输入 /** 后按回车，插件会自动解析函数签名并生成结构化注释。
4. 使用 DoxyDoxygen 生成注释
以 C++ 函数为例：
int calculateSum(int a, int b);
将光标置于该行上方，输入 /** 并回车，插件自动生成如下注释：
/** * @brief * * @param a * @param b * @return int */
你只需补充说明内容即可。支持的语言包括 C/C++、Python、Java、php、javascript 等。
5. 自定义注释模板（可选）
DoxyDoxygen 支持自定义模板文件，路径通常位于：
- Windows:
~/appData/Roaming/Sublime Text 3/Packages/DoxyDoxygen/templates/ - macOS/Linux:
~/.config/sublime-text-3/Packages/DoxyDoxygen/templates/
你可以复制默认模板并修改，比如添加作者、日期等字段：
/** * @author ${user} * @date ${date} * @brief ${cursor} */
6. 快捷键与常用操作
-
/** + Enter：生成函数/类注释 -
Ctrl+Alt+D（Windows/Linux）或Cmd+Alt+D（Mac）：快速插入 Doxygen 注释块 - 在已有注释中按
Tab可跳转到下一个字段进行填写
基本上就这些。配置完成后，你可以在写代码时快速生成标准化的文档注释，提升代码可读性和维护性。