安装并配置DocBlockr插件可高效生成结构化代码注释。1. 通过Package Control搜索安装DocBlockr；2. 在函数上方输入/**并回车，自动识别参数与返回值生成注释；3. 支持php、javaScript、python、Java等语言，常用标签包括@param、@return、@author等；4. 可自定义配置添加作者、版本信息，启用段间距提升可读性，配置后每次生成注释均自动包含指定内容，显著提升编码效率与代码可维护性。
在使用 sublime Text 进行开发时，良好的注释不仅能提升代码可读性，还能方便团队协作和后期维护。通过安装 DocBlockr 插件，你可以快速生成结构化的函数或类注释文档，大幅提升编码效率。下面详细介绍如何配置和使用该插件。
1. 安装 DocBlockr 插件
DocBlockr 是一个轻量且功能强大的注释生成工具，支持多种语言（如 PHP、javascript、Python、Java 等）。安装方式非常简单：
- 确保已安装 Package Control（Sublime 的插件管理工具）
- 按下 Ctrl+Shift+P（Mac 上为 Cmd+Shift+P）打开命令面板
- 输入 “Install Package”，选择对应选项
- 搜索 “DocBlockr”，点击安装即可
2. 快速生成注释的方法
安装完成后，在函数上方输入 /** 并回车，插件会自动根据函数定义生成参数、返回值等信息。
例如，在 JavaScript 中写如下函数：
function calculateArea(width, height) {
return width * height;
}
将光标放在函数上方，输入 /** 后按回车，自动生成类似以下注释：
/**
* [calculateArea description]
* @param {number} width
* @param {number} height
* @return {number}
*/
你只需补全描述内容即可。
3. 支持的语言与常用标签
DocBlockr 能智能识别多种语言的语法结构，常见支持包括：
- PHP：支持 @param、@return、@throws、@var 等
- JavaScript：可解析 es6 和 typescript 风格函数
- Python：识别 def 函数和 self 参数处理
- Java：自动提取类型和方法签名
常用注释标签说明：
- @param {type} name – 描述参数类型和名称
- @return {type} – 描述返回值类型
- @author – 添加作者信息（需配置）
- @deprecated – 标记废弃方法
4. 自定义配置提升体验
你可以通过修改 DocBlockr 的设置来自定义注释模板，比如添加作者、日期等。
进入菜单：Preferences → Package Settings → DocBlockr → Settings – User
添加如下配置示例：
{
“jsdocs_extra_tags”: [
“@author MyName”,
“@version 1.0”
],
“jsdocs_spacer_between_sections”: true,
“jsdocs_extend_description”: false
}
保存后，每次生成注释都会自动包含 author 和 version 字段。
基本上就这些。熟练使用 DocBlockr 后，写注释不再是负担，而是顺手完成的事。不复杂但容易忽略的是细节配置，花几分钟调整一下，长期收益明显。