Sublime Text需通过Package Control手动安装DocBlockr插件;安装后在支持语言的函数/类声明正上方输入/**+Tab才能触发注释生成,且文件语法须正确识别为对应语言(如JavaScript)。

Sublime Text 本身不自带 DocBlockr 插件,必须手动安装;装完后 /** + Tab 才能触发文档注释生成,不是所有符号组合都有效。
怎么安装 DocBlockr 插件
DocBlockr 不在 Sublime 默认源里,得用 Package Control 安装:
- 确保已安装
Package Control(没装的话搜 “Install Package Control” 官方脚本运行一次) -
Ctrl+Shift+P(Windows/Linux)或Cmd+Shift+P(macOS)呼出命令面板 - 输入
Package Control: Install Package回车 - 再输入
DocBlockr,选中后回车安装 - 安装完不用重启,但建议关掉再打开当前文件,让插件识别语言类型
为什么敲 /** 没反应
常见原因不是插件没装好,而是上下文不满足触发条件:
- 光标必须在函数、类、方法、变量声明的正上方(空行也算),且该语言被 DocBlockr 支持(如
JavaScript、PHP、Python默认支持,Vue或TSX需额外配置) - 当前文件语法必须正确识别:右下角状态栏应显示
JavaScript而不是Plain Text;点一下切换,或用Ctrl+Shift+P→Set Syntax: JavaScript - 不能在字符串、注释块内部、缩进过深的嵌套里敲
/** - 确认设置了快捷键:默认是
Tab,不是Enter或Space
如何自定义 @param 和 @return 的格式
DocBlockr 允许按项目习惯调整字段顺序和占位符,靠修改用户配置实现:
- 菜单栏 →
Preferences→Package Settings→DocBlockr→Settings – User - 填入类似下面的 JSON(以 JS 为例):
{
"jsdocs_extra_tags": [
"@author",
"@since"
],
"jsdocs_indentation_spaces": 2,
"jsdocs_spacer_between_sections": true,
"jsdocs_function_description": true
}
关键点:"jsdocs_function_description" 开启后会在函数名下方自动加一行空描述;"jsdocs_spacer_between_sections" 控制 @param 和 @return 之间是否空行。
常见错误:生成的注释参数名为空或错乱
这是解析失败的典型表现,多见于:
- 函数使用了箭头函数且没写参数名,例如
const fn = (a, b) => {}可解析,但const fn = _ => {}就无法提取参数 - 用了解构参数但 DocBlockr 版本太老(v3.15.0+ 才较好支持
({ a, b }) => {}) - 函数定义跨多行、有类型注解(如 TypeScript 的
(a: string): number =>),旧版 DocBlockr 会丢参数 - 当前作用域有同名变量干扰解析(少见,但存在)
遇到这类问题,先升级插件:Package Control: Upgrade Package → DocBlockr;还不行就手动补全 @param,别依赖全自动。










