安装并使用DocBlockr插件可快速生成标准文档注释。1. 通过Package Control搜索安装DocBlockr；2. 在函数或类上方输入/**后回车，自动解析代码生成注释；3. 支持JavaScript、PHP等多种语言，输入@可触发标签补全；4. 可自定义配置添加作者、版本等信息，提升注释效率与代码规范性。
DocBlockr 是 Sublime Text 中非常实用的代码注释插件，能帮助开发者快速生成函数、类、变量等的文档注释（如 JSDoc、PHPDoc 等）。安装后只需简单操作即可自动生成结构清晰的注释块，提高代码可读性和维护性。
1. 安装 DocBlockr 插件
使用 Package Control 安装是最简单的方式：
- 按下 Ctrl+Shift+P（Mac 上是 Cmd+Shift+P）打开命令面板
- 输入 “Install Package”，选择对应选项
- 搜索 “DocBlockr”，点击安装即可
安装完成后无需重启，直接在代码中使用。
2. 基本使用方法
在函数或类上方输入 /** 然后回车，DocBlockr 会自动解析下方代码并生成对应注释。
例如，在 JavaScript 中：
/**
* @param {string} name
* @param {number} age
* @returns {boolean}
*/
function createUser(name, age) {
// ...
}
输入 /** 并回车后，插件会自动提取参数名、类型（若能推断），并生成标准格式注释。
3. 支持的语言与标签自动补全
DocBlockr 支持多种语言，包括：
- JavaScript / TypeScript
- PHP
- Python
- Java
- C++ / C#
输入 @ 后会弹出可用标签提示，如 @param、@return、@author、@version 等。按 Tab 可快速填写字段。
4. 自定义配置（可选）
可通过设置添加作者信息、默认描述等：
- 进入菜单：Preferences → Package Settings → DocBlockr → Settings - User
- 添加如下配置示例：
{
"jsdocs_extra_tags": [
"@author John Doe",
"@version 1.0.0"
],
"jsdocs_extend_name": true,
"jsdocs_spacer_between_sections": true
}
这样每次生成注释时会自动包含作者和版本信息。
基本上就这些。熟练使用 DocBlockr 能大幅提升写注释效率，让代码更专业。不复杂但容易忽略细节，比如参数类型推断依赖命名规范，建议配合良好的编码习惯使用。
