0

0

sublime怎么安装DocBlockr_sublime自动生成文档注释【工具】

穿越時空

穿越時空

发布时间:2026-03-15 10:23:14

|

200人浏览过

|

来源于php中文网

原创

DocBlockr 是 Sublime Text 的第三方注释模板插件,需通过 Package Control 安装,仅在支持语言(如 JS/PHP)且语法模式正确、触发符 /** 位于函数/类正上方时生效;ST4 用户应改用 DocBlockr-Alt 分支。

sublime怎么安装docblockr_sublime自动生成文档注释【工具】

DocBlockr 是什么,为什么装了没反应

DocBlockr 不是 Sublime 自带功能,它是个第三方插件,作用是在函数、类等位置敲 /** 回车后自动生成注释模板。装了没反应,大概率是没正确安装或没触发对的语法环境。

  • 必须用 Package Control 安装,手动丢文件进 Packages/ 目录容易漏依赖或路径错
  • 只对支持的语言生效:默认支持 JavaScriptPHPPythonJava 等,但 CGo 需额外配置或不支持
  • 当前文件的语法模式(右下角显示)必须匹配,比如文件是 test.js 但被识别成 Plain Text/** 就不会触发

用 Package Control 正确安装 DocBlockr

别去 GitHub 下 ZIP 手动解压——路径错、权限错、少 sublime-package 文件都会导致失效。

  • Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(macOS),调出命令面板
  • 输入 Package Control: Install Package,回车
  • 等待列表加载完,再输入 DocBlockr,选中并回车
  • 安装完成后不用重启,但建议关掉所有文件再重开一次,避免缓存干扰

写对触发符,且光标位置要准

/** 必须写在函数/方法/类定义的正上方,且前面不能有空行或非空白字符;否则插件判断不到上下文,直接当普通注释处理。

小微助手
小微助手

微信推出的一款专注于提升桌面效率的助手型AI工具

下载
  • ✅ 正确位置:
    /**
     * 
     */
    function foo() {}
  • ❌ 错误位置:
    console.log('hi');
    /**
     * 
     */
    function foo() {}
    (前面有代码,不触发)
  • ❌ 错误写法:/*/**/,只有 /** + 换行才激活 DocBlockr
  • 参数提取依赖语言服务,JavaScript 能读 function(a, b),但 const fn = (a, b) => {} 可能解析失败,这是已知限制

常见报错和兼容性注意点

Sublime Text 4 用户会遇到 AttributeError: 'NoneType' object has no attribute 'groups' 这类错误,本质是 DocBlockr 原版未适配 ST4 的 API 变更。

  • 解决办法:安装社区维护的分支 DocBlockr-Alt(同样通过 Package Control 搜索安装),它兼容 ST4 且持续更新
  • 如果用了 NodeReplESLint 类插件,偶尔会和 DocBlockr 抢 Tab 行为,可在 Preferences → Package Settings → DocBlockr → Settings 中设 "auto_indent": false
  • 中文 Windows 用户若发现注释里出现乱码字段(如 @author ),检查 Sublime 的 fallback_encoding 设置是否为 UTF-8

真正卡住人的不是“怎么装”,而是装完没反应时不知道该看语法模式、触发位置还是版本兼容性——这几个点串起来,基本覆盖 90% 的失败场景。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
c语言const用法
c语言const用法

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

564

2023.09.20

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

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

531

2023.06.20

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

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

576

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

761

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

6284

2023.08.17

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

494

2023.09.01

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

240

2023.09.14

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

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

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