Sublime Text安装DocBlockr注释插件提高规范性

P粉328763957

P粉328763957

2026-05-03

916人浏览

原创

docblockr没反应主因是语法模式错误、光标位置不准或st4不兼容;需确保右下角显示javascript等支持语言,光标在函数定义行任意位置,敲/**后回车,st4用户必须改用docblockr-alt。

sublime text安装docblockr注释插件提高规范性

装了 DocBlockr 却没反应,不是插件坏了,而是触发条件没满足——90% 的失败都卡在语法模式、光标位置或 ST4 兼容性这三点上。

怎么确认 DocBlockr 真正生效了

它不靠“安装完成”就自动工作,必须同时满足:当前文件被 Sublime 识别为支持语言(如 JavaScript 而非 Plain Text),光标位于函数/类定义行的任意位置(不是空行、不是函数体内),且敲的是 /** 后直接回车。

  • 右下角状态栏显示 Plain Text?点它手动切到 JavaScript 或对应语言
  • 写的是 const fn = (a, b) => {}?原版 DocBlockr 不解析箭头函数,得改成 function fn(a, b) {} 或换用 DocBlockr-Alt
  • 按了 /** 没反应?别急着重装,先检查上面两个点

为什么 /** 回车后 @param 是空的

DocBlockr 不推断类型,只提取参数名。它看到 function getUser(id, options) 就生成两行 @param {any} id@param {any} options,花括号里的 {any} 是占位符,不是自动识别结果。

Sublime Text Build Linux版
Sublime Text Build Linux版

Sublime Text Linux x86-64 deb 安装包。官方也提供 rpm、tar.xz 和软件源安装方式。

下载
  • 类型得你手动补,比如改成 @param {string} id
  • JS 中写 /** @type {number} */ 这类内联注释,DocBlockr 也不会读取——它只看函数签名文本结构
  • 解构参数 ({ a, b }) 或默认值 (a = 1) 会导致参数名错乱,建议生成后人工校对

Sublime Text 4 用户必须装 DocBlockr-Alt

原版 DocBlockr 在 ST4 上会报 AttributeError: 'NoneType' object has no attribute 'groups',这是 API 变更导致的硬兼容问题,不是配置错误。

  • 卸载原版 DocBlockr(Preferences → Package Settings → Package Control → Remove Package)
  • 再用 Package Control 安装 DocBlockr-Alt,它专为 ST4 维护,支持最新语法高亮和作用域匹配
  • 装完不用重启,但建议关掉所有文件重开一次,避免旧缓存干扰

自定义作者、日期等字段不生效的真正原因

很多人改了 Preferences → Package Settings → DocBlockr → Settings – User 却没效果,是因为写错了配置项名或格式。

  • 正确字段是 "jsdocs_extra_tags"(不是 jsdoc_extra_tagsextra_tags
  • 值必须是数组,例如:"jsdocs_extra_tags": ["@author MyName", "@since 2026"]
  • 配置里不能有 trailing comma,JSON 语法错误会让整个设置失效
  • 改完保存,然后在函数上方重新敲 /** 回车,旧注释块不会自动更新

最常被忽略的是:它不处理已存在的注释块,也不监听函数修改——每次都要重新触发 /** 才能生成新模板。想省事,就别依赖自动识别,把光标放对、敲对符号、选对分支,比调参数快得多。

相关文章

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

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

下载

相关标签:

sublime

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

相关专题

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

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

2023.06.20

1373

3

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

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

2023.07.25

1561

9

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

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

2023.08.02

692

5

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

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

2023.08.09

551

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

910

5

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

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

2023.09.20

1128

7

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

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

2023.09.20

1684

8

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

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

2023.09.22

5657

6

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

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

2023.09.22

420

3

热门下载

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

精品课程

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