sublime如何集成Doxygen或JSDoc生成代码文档？ (DocBlockr插件)

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 不内置构建系统，但可手动或集成终端运行。

标签： php javascript java html sublime js npm 浏览器 app 工具 c++