讲师中心 微信公众号
AI工具推荐 视频效率加速

Sublime怎么安装DocBlockr插件_Sublime快速生成标准注释文档

落雪君_7029

落雪君_7029

发布时间:2026-04-29 16:42:01

|

656人浏览过

|

来源于php中文网

原创

Sublime Text 4 用户应弃用已停止维护的DocBlockr,改用DoxyDoxygen;它支持多语言、LSP集成,需注意Jinja2模板语法、键位冲突及配置适配。

sublime怎么安装docblockr插件_sublime快速生成标准注释文档

DocBlockr 在 Sublime Text 4 上已停止维护,直接安装会失败或生成空注释;ST3 用户也需注意 Python 3.8+ 下 inspect.getargspec 被弃用导致崩溃。别硬装,先看版本和需求。

Sublime Text 4 用户:别装 DocBlockr,改用 DoxyDoxygen

官方仓库明确标为 “unmaintained”,ST4 的异步加载机制和新 API(如 view.substr(view.word(point)) 返回空字符串)会让它在解析函数签名时直接抛 AttributeError: 'NoneType' object has no attribute 'groups'。

  • 打开命令面板(Ctrl+Shift+P / Cmd+Shift+P),输入 Package Control: Install Package,搜 DoxyDoxygen(注意拼写,不是 DocBlockr)
  • 装完不用重启,但必须确认右下角语法模式是 JavaScript、Python 等支持语言,不能是 Plain Text
  • 触发方式不是敲 /** 回车,而是把光标放在函数定义行(如 def fetch_user(id: int) -> dict:),按 Ctrl+Alt+D(Windows/Linux)或 Cmd+Alt+D(macOS)
  • 若用 TypeScript 或 Babel 插件,可能覆盖语法高亮——临时切回原生 JavaScript 模式再试

Sublime Text 3 用户:能用但限制极多

DocBlockr 在 ST3 上仍可工作,但只对特定写法有效,不是所有函数都能识别。

  • 仅支持 function foo(a, b) 这类 function 关键字声明,const foo = (a, b) => {} 或解构参数 function bar({ id }) 会漏字段甚至不触发
  • 光标必须严格位于函数正上方的**空行**——该行不能有空格、制表符、注释,前面也不能有空行
  • 输入 /** 后必须立刻按 Enter(不是 Tab),否则不展开
  • 中文 Windows 用户若见 @author 显示方块,检查 fallback_encoding 是否设为 "UTF-8"

自定义模板时变量语法必须重写

DoxyDoxygen 用 Jinja2,DocBlockr 用 ${1:description},二者完全不兼容。直接复制旧模板会导致字段消失或整行跳过。

  • 去掉所有 $ 和序号:{description},不是 ${1:description}
  • @param 循环必须写成:{% for param in params %}@param {param.type} {param.name}{% endfor %}
  • 想让 @return 在无返回值时也显示,得加判断:{% if return_type %}@return {return_type}{% endif %}
  • JS 解构参数(如 (options = { timeout: 5000 }))需开启配置项 js_extract_destructured_params 才能正确列出 options.timeout

装不上?先查 Package Control 是不是活的

搜不到 DocBlockr 或 DoxyDoxygen,大概率不是插件没了,而是 Package Control 本身没装好或卡住。

  • 命令面板里输 Package Control: Install Package —— 如果没这个选项,说明 Package Control 没初始化成功
  • 按 Ctrl+` 打开控制台,粘贴 packagecontrol.io/installation 页面上的最新 Python 安装脚本,回车执行
  • 等它输出 Package Control initialized. 再重启 Sublime
  • 搜索时输全小写 docblockr 或 doxydoxygen,首字母大写或拼错就匹配不到
真正卡住人的从来不是“怎么装”,而是装完没反应时不知道该盯语法模式、光标位置、ST 版本,还是模板语法。这几个点串起来,问题基本就定位了。

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

相关专题

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

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

3669

2023.06.20

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

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

2448

2023.07.25

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

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

1400

2023.08.02

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

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

1338

2023.08.09

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

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

1436

2023.09.05

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

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

2378

2023.09.20

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

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

3940

2023.09.20

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

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

18635

2023.09.22

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

0

2026.11.05

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn