安装并配置DocBlockr插件后，在Sublime Text中输入/**并回车即可自动生成函数注释块，支持参数、返回值、作者、版本等信息的自动填充，提升代码规范性与开发效率。
在 Sublime Text 中使用 DocBlockr 插件可以快速生成函数、类、变量等的注释块，提升代码可读性和开发效率。配置合适的注释模板能让自动生成的内容更符合团队规范或个人习惯。
安装 DocBlockr 插件
打开 Sublime Text，使用 Package Control 安装插件：
- 按下 Ctrl+Shift+P（Mac 上是 Cmd+Shift+P）调出命令面板
- 输入 "Install Package" 并选择对应选项
- 搜索 DocBlockr，点击安装
安装完成后，保存为 JavaScript、PHP、Python 等支持的文件类型时，在函数上方输入 /** 并回车，即可触发注释生成。
配置自定义注释模板
DocBlockr 支持通过设置来自定义注释内容。进入配置路径：
- 菜单栏选择 Preferences → Package Settings → DocBlockr → Settings - User
- 在打开的文件中添加个性化配置项
常见配置示例（以 JSON 格式写入用户设置）：
{
// 开启函数参数自动填充
"auto_complete": true,
// 自动添加 @author
"author_tag": " * @author yourname \n",
// 添加日期格式
"date_format": "%Y-%m-%d",
// 自动生成 return 标签
"auto_add_return_value": true,
// 是否启用 TypeScript 风格标签
"jsdoc_enable_types": true,
// 自定义模板：例如添加版权信息
"custom_tags": [
" @version 1.0.0",
" @copyright 2025 Your Company"
]
}
使用技巧与注意事项
- 确保文件语法正确识别（如 JS、PHP），否则可能无法触发注释
- 在函数前输入 /** + 回车，而非 /*** 或 /*
- 支持多行参数自动提取，包括类型和说明
- 可通过 Tab 键在注释字段间跳转编辑
- 部分语言如 Python 可结合 sphinx 风格使用，需开启相应选项
基本上就这些。合理配置后，每次写函数都能一键生成结构清晰的注释，省时又规范。
