安装DocBlockr插件后,在函数上方输入/**并回车,即可自动生成包含@param、@return等标签的结构化注释块,支持多种语言并可自定义配置提升效率。

在 Sublime Text 中快速生成注释块,可以借助 DocBlockr 插件高效编写函数或类的文档注释。安装并配置后,只需简单操作就能自动生成结构化的注释块,提升代码可读性和开发效率。
安装 DocBlockr 插件
使用 Package Control 安装 DocBlockr 是最便捷的方式:
- 按下 Ctrl+Shift+P(Mac 上是 Cmd+Shift+P)打开命令面板
- 输入 "Install Package" 并选择对应选项
- 搜索 "DocBlockr",点击安装即可
快速生成注释块的方法
安装完成后,在函数上方输入 /** 然后回车,DocBlockr 会自动解析函数参数、返回值等信息,生成标准注释块。
- 在 JavaScript、PHP、Python 等语言中均支持自动提取参数名和类型
- 例如在 PHP 中写 function test($name, $age),在其上方输入 /** 回车,会自动生成包含 @param 的注释
- 支持 @return、@author、@version 等常用标签自动填充
常用技巧与设置
进一步提升使用体验,可以调整插件设置:
- 通过 Preferences → Package Settings → DocBlockr → Settings 查看和修改配置
- 启用 "jsdocs_extra_tags" 添加常用标签如 @since 或 @example
- 设置 "jsdocs_extend_name" 控制注释对齐风格
- 输入 /** + tab 可快速触发补全(部分版本支持)
基本上就这些,配合语法高亮和缩进设置,DocBlockr 能让 Sublime Text 的文档编写变得非常顺畅。










