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 没反应

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

人民网AIGC-X
人民网AIGC-X

国内科研机构联合推出的AI生成内容检测工具

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

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

它依赖光标位置和代码上下文,不是 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 在不同上下文的位置,比查文档更快摸清边界。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

47

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

192

2026.02.25

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1010

2023.08.02

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

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

562

2023.09.20

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

870

2024.01.03

python中class的含义
python中class的含义

本专题整合了python中class的相关内容,阅读专题下面的文章了解更多详细内容。

30

2025.12.06

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

530

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

576

2023.07.28

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共137课时 | 13.4万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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