sublime Text 通过 DocBlockr 插件高效编写 Doxygen/jsDoc 注释，再调用 doxygen 或 jsdoc 命令生成静态文档。安装 DocBlockr 后输入 /** + Enter 自动生成结构化注释，支持自定义模板；需手动或配置构建系统运行外部 工具 生成 html 文档。
sublime text 本身不直接生成 Doxygen 或 JSDoc 文档，但可以通过插件（如 DocBlockr）快速编写符合规范的注释块，再配合外部 工具 生成最终文档。核心思路是：用 DocBlockr 高效写注释 → 手动或脚本调用 doxygen/jsdoc 命令生成 HTML/ 其他格式文档。
安装并配置 DocBlockr（支持 C/c++/java/JS/php 等）
DocBlockr 是 Sublime 上最成熟的注释模板插件，能自动补全函数、类、参数等结构化注释，兼容 Doxygen 和 JSDoc 语法。
- 通过 Package Control 安装：Ctrl+Shift+P → 输入 Install Package → 搜索 DocBlockr → 回车安装
- 安装后，在函数 / 方法上方输入 /** + Enter，即可自动生成带 @param、@return、@brief 等字段的注释块
- 支持自定义模板：Preferences → Package Settings → DocBlockr → Settings，可修改
"jsdoc": true或"doxygen": true启用对应风格 - 例如在 JS 中写：
/**
* @function calculateTotal
* @param {number} a – first number
* @param {number} b – second number
* @returns {number} sum
*/
Sublime 会自动识别并高亮这些标签
用命令行生成真实文档（Doxygen / JSDoc）
DocBlockr 只负责“写”，生成静态文档需调用外部工具。Sublime 不内置构建系统，但可手动或集成终端运行。
- Doxygen：先写好
Doxyfile（用doxygen -g生成），确保注释含/** …… */且启用EXTRACT_ALL = YES等选项，然后终端执行：
doxygen Doxyfile - JSDoc：全局安装后（
npm install -g jsdoc），在项目根目录运行：
jsdoc src/*.js -d docs
会解析所有含 JSDoc 注释的 JS 文件，输出到docs/ - 可在 Sublime 中用 Tools → Build System → New Build System 创建快捷命令（如保存为
JSDoc.sublime-build），内容示例：
{“shell_cmd”: “jsdoc $file -d ./docs”}
小技巧提升效率
让写注释和生成文档更顺滑，不用频繁切窗口。
- 开启 DocBlockr 的
"auto_add_jsdoc": true，保存时自动补全缺失的 @param/@returns - 用 Sublime 的侧边栏右键 → Open in Terminal（需安装 Terminal 插件），快速唤起终端执行生成命令
- 对大型项目，把生成命令写成 shell 脚本（如
gen-doc.sh），一键完成清理 + 生成 + 打开 浏览器 - 注意：Doxygen 默认不解析 JS；若要支持，需在 Doxyfile 中设
FILE_PATTERNS = *.js和EXTENSION_MappING = js=javascript
基本上就这些。DocBlockr 解决“怎么写得快又标准”，外部工具解决“怎么变成可浏览的文档”。两者配合，不需要额外 GUI，轻量又可靠。
以上就是 sublime 如何集成 Doxygen 或 JSDoc 生成代码文档？(DocBlockr 插件）的详细内容，更多请关注 php 中文网其它相关文章！
