Sublime Text怎么快速插入注释块_Sublime Text自定义DocBlockr设置【规范】

星丽吖_4816

星丽吖_4816

2026-05-18

168人浏览

原创

sublime text原生不支持docblock注释自动补全,必须依赖docblockr插件或自定义snippet;docblockr通过正则匹配函数声明行生成带@param占位符的结构化注释,但不解析类型注解且要求光标位于函数定义行开头。

sublime text怎么快速插入注释块_sublime text自定义docblockr设置【规范】

Sublime Text 本身不提供开箱即用的 DocBlock 注释块(如 /** */ 或 /** @param ... */)自动补全,原生 Ctrl+Shift+/ 只能插入基础块注释(/* */),且不识别函数签名、参数、返回值等语义。要实现「输入 /** + Enter 自动展开为带参数占位符的文档注释」,必须依赖插件或手动配置 snippet —— 没有捷径,也别指望改几个键绑定就能搞定。

DocBlockr 插件是唯一靠谱的起点

原生 Sublime 不解析 JS/PHP/Python 的函数定义,所以无法自动生成 @param 列表。DocBlockr 是目前最稳定、适配语言最多、更新持续的插件,它通过正则匹配函数声明行(如 function foo($a, $b) 或 def bar(x: int) -> str:)来推导参数名和类型。

  • 安装后,光标停在函数名上方,输入 /** 再按 Enter,就会生成结构化注释模板
  • 支持 JavaScript、TypeScript、PHP、Python(需额外配置)、Go、Rust 等主流语言
  • 不依赖语法高亮模式(syntax),但要求当前文件已正确设为对应语言(右下角显示 JavaScript 而非 Plain Text)
  • 若生成结果为空或字段错乱,大概率是函数签名格式不符合插件预设正则——比如 JS 中用了箭头函数且无显式 function 关键字,或 Python 中类型提示写法太新(def f(x: Annotated[int, "id"]) -> None:)

不装插件?用 snippet 手动兜底

如果你只在固定几种场景用 DocBlock(比如只写 JS 函数文档),snippet 是轻量、可控、不冲突的替代方案。它不自动推导参数,但能保证格式统一、快捷触发。

Question AI
Question AI

一款面向学习和知识查询场景的AI助手,提供问题解答、内容和智能搜索等功能。

下载
  • 打开 Tools → Developer → New Snippet...
  • 填入内容(以 JS 为例):
    <snippet><content><tabtrigger>doc</tabtrigger><scope>source.js</scope></content></snippet>
  • 保存为 Packages/User/js-doc.sublime-snippet
  • 在 JS 文件中输入 doc + Tab,即可插入预设结构
  • <scope></scope> 必须写对:JS 是 source.js,Python 是 source.python,PHP 是 source.php —— 错了就触发不了

为什么 Ctrl+Shift+/ 总是生成空 /* */?

这个快捷键调用的是 Sublime 原生的 toggle_comment 命令,参数为 {"block": true}。它只做一件事:在选中文本前后插入语言定义的 comment_block_start 和 comment_block_end 符号(如 JS 是 /* 和 */)。它完全不分析代码结构,也不补任何字段。

  • 你没选中任何文本时按 Ctrl+Shift+/,Sublime 会把整行当“选中内容”,结果就是 /* console.log("x"); */
  • 你选中了函数体(不含函数声明),它照样只包一层 /* ... */,不会加 @param
  • 如果当前语法没定义 comment_block_start(比如某些自定义 .env 语法),该快捷键直接静默失效
  • 想让它“智能”,只能换插件;想让它“可靠”,就老实用 snippet

容易被忽略的细节:作用域与激活时机

DocBlockr 和 snippet 都极度依赖 Sublime 的 scope 机制。不是“文件后缀对就行”,而是光标所在位置的 scope 必须匹配规则。比如:

  • 在 JS 文件里,函数内部写 /** + Enter,可能触发失败——因为光标 scope 是 source.js meta.function.js,而插件只监听 source.js 下的函数声明行(meta.function.js entity.name.function.js)
  • Python 中用了 async def,默认 DocBlockr 可能不识别,需在插件设置里启用 enable_async_def
  • snippet 的 <scope></scope> 值必须精确到子 scope,比如 Vue 单文件组件里的 <script></script> 区域要用 source.js.embedded.html,而非简单写 source.js

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

sublime

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2889

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2208

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1180

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1118

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1316

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2038

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3200

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14195

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

529

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程