DocBlockr 是 Sublime Text 的注释生成插件，支持 JavaScript、PHP 等多种语言，通过输入 /** 回车即可自动生成包含 @param、@return 等标签的文档注释，配合快捷键与自定义配置（如作者、日期），大幅提升代码注释效率与规范性。
DocBlockr 是 Sublime Text 中非常实用的注释生成插件，能够快速为函数、类、变量等代码元素生成规范的文档注释（如 JSDoc、PHPDoc 等格式）。它支持多种语言，包括 JavaScript、PHP、Python、Java、C++ 等。
下面介绍如何使用 DocBlockr 插件来提高编码效率。
安装 DocBlockr
在使用之前，先安装插件：
- 打开 Sublime Text，按下 Ctrl+Shift+P（Windows/Linux）或 Cmd+Shift+P（Mac）调出命令面板。
- 输入 “Install Package”，选择 “Package Control: Install Package”。
- 等待包列表加载完成后，搜索 “DocBlockr”，点击安装即可。
基本使用方法
安装完成后，只需在函数或类上方输入 /** 并回车，DocBlockr 就会自动生成对应的注释模板。
示例（JavaScript）：
/**
* @param {string} name
* @param {number} age
* @return {boolean}
*/
function createUser(name, age) {
// 函数内容
}
当你在函数上方输入 /** 后按回车，插件会自动解析函数参数并填充到 @param 中。
示例（PHP）：
/**
* 添加用户信息
*
* @param string $name 用户名
* @param int $age 年龄
* @return bool 是否创建成功
*/
public function createUser($name, $age)
{
// 方法逻辑
}
常用配置与技巧
可以通过修改设置来自定义注释格式和行为：
- 进入菜单栏：Preferences → Package Settings → DocBlockr → Settings - User
- 可以添加如下常用配置：
{
// 显示参数类型提示
"jsdocs_show_type": true,
// 自动补全 return 标签
"jsdocs_return_tag": "@return",
// 设置作者信息
"jsdocs_author_name": "yourname",
"jsdocs_author_email": "",
// 自动生成日期
"jsdocs_use_inline_tags": false,
// 支持更多语言
"jsdocs_extend_double_slash": true
}
配置后，生成的注释中会自动包含作者、日期等信息。
快捷键与高级功能
- /** + Enter：生成标准函数注释（最常用）
- Ctrl+Alt+/（部分系统）：快速插入文档块
- ///：在某些语言（如 C#）中也能触发注释生成
- 支持为变量添加注释，例如在变量前写 /** 回车可生成 @type 说明
- 支持多行注释自动对齐，提升可读性
在编写大型项目时，良好的注释能极大提升代码可维护性。DocBlockr 能帮你节省大量手动输入时间。
基本上就这些，不复杂但容易忽略细节。熟练使用后，写注释变得又快又规范。
