0

0

Sublime怎么快速生成DocBlock注释 Sublime函数注释插件DocBlockr【神器】

冰火之心

冰火之心

发布时间:2026-01-25 12:35:02

|

902人浏览过

|

来源于php中文网

原创

应安装 nikhilm 维护的 DocBlockr for Sublime Text 3(GitHub 仓库 sublimetext-docblockr),装后重启,确保文件语法为 JS/PHP/TS 等支持类型,在函数定义正上方输入 /** 后按 Enter 才能正确生成注释。

sublime怎么快速生成docblock注释 sublime函数注释插件docblockr【神器】

Sublime Text 本身不自带 DocBlock 注释生成功能,但通过插件 DocBlockr(现维护版本为 DocBlockr for Sublime Text 3)可以一键生成符合 PHP/JS/TS/Python 等语言规范的函数注释块——前提是配置正确、触发方式用对,否则容易按了 Tab 没反应或生成空行。

怎么安装 DocBlockr 插件并确保它生效

别直接搜 “DocBlockr” 装错旧版;Sublime Text 3/4 应装社区维护的活跃分支:

  • 打开 Command PaletteCtrl+Shift+P / Cmd+Shift+P),输入 Package Control: Install Package
  • 搜索并安装 DocBlockr(作者是 nikhilm,GitHub 仓库名是 sublimetext-docblockr
  • 装完重启 Sublime(部分版本需手动重启才加载新插件)
  • 验证是否生效:在 JS 或 PHP 文件中,输入 /** 后按 Enter,应自动补全基础注释结构

为什么敲完 /** + Enter 没反应

常见原因不是插件没装,而是文件语法类型没识别对,或快捷键被覆盖:

  • 确认当前文件右下角显示的是 JavaScriptPHPTypeScript 等支持语言,不是 Plain Text(点它手动切换)
  • DocBlockr 默认监听 Enter,不是 Tab;按 Tab 是在已有注释里跳转字段,不是生成注释
  • 检查是否有其他插件(如 Emmet)劫持了 Enter 行为;可临时禁用其他插件测试
  • 若仍无效,在 Preferences → Package Settings → DocBlockr → Settings 中确认 "auto_indent": true"jsdoc_extra_tags" 等基础项未被设为 false

如何让 DocBlockr 正确提取函数名和参数

它依赖光标位置和代码上下文,不是 AI,所以必须“站在函数定义行上方”才能解析准确:

Gaga
Gaga

曹越团队开发的AI视频生成工具

下载
  • 把光标放在函数声明的正上方一行(例如 function foo(a, b) { 的上一行),再输 /** + Enter
  • 支持的函数格式包括:function name()const name = () => {}class A { method() {} }def method(self):(Python)
  • 参数提取只读当前行括号内内容,不解析解构、默认值或类型注解(如 (a: string, ...rest: number[]) 会被简化为 a, rest
  • 若函数无显式参数(如 () => {}),它会生成空 @param 行,需手动删或补

生成后怎么快速填内容、避免手敲每个 @param

生成的占位符支持 Tab 键顺序跳转,但得知道默认字段顺序和编辑逻辑:

  • 首次生成后,光标停在 @description 区域;按 Tab 依次跳到每个 @param@return@throws
  • 每个 @param 行末尾有 {type} 占位符,删掉即可写具体类型(如 {string}),留空也合法
  • 想加自定义标签(如 @since@example),可在 Preferences → Package Settings → DocBlockr → Settings 中修改 "jsdoc_extra_tags" 数组
  • 注意:回车换行时,如果光标在注释块内,DocBlockr 会自动缩进下一行并补 * ;但退出注释块后这个行为就失效了

真正卡住人的往往不是不会装插件,而是光标没放对位置、文件语法类型没切对、或者误以为按 Tab 就能生成注释——它只负责补全,不负责理解业务逻辑。多试两次 /** + Enter 在不同上下文的位置,比查文档更快摸清边界。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

775

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

684

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

768

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

739

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1445

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

571

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

751

2023.08.11

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

58

2026.01.23

热门下载

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

精品课程

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

共137课时 | 9.3万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 10.8万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号