Sublime安装DocBlockr插件:标准代码注释一键生成

小磊大大_3262

小磊大大_3262

2026-06-19

402人浏览

原创

sublime text 4 用户应弃用 docblockr,改用 doxydoxygen;因 docblockr 已停止维护,不兼容 st4 异步机制与新 api,安装失败或触发崩溃,而 doxydoxygen 专为 st4 重写,支持多语言、lsp 集成及 jinja2 模板语法。

sublime安装docblockr插件:标准代码注释一键生成

Sublime Text 4 用户别装 DocBlockr,它已停止维护,装了也大概率不工作;ST3 用户能用但限制极多,推荐直接切到 DoxyDoxygen。

Sublime Text 4 安装 DocBlockr 必然失败的三个原因

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

  • 不是网络问题或拼写错误——搜不到 DocBlockr 是因为 Package Control 已将其从索引中移除
  • 手动从 GitHub clone 到 Packages/ 目录会加载失败,或触发后生成空注释块
  • 即使降级 Python 运行时,inspect.getargspec 在 Python 3.8+ 中已被弃用,仍会抛 ValueError

ST4 正确替代方案:安装 DoxyDoxygen

它是 DocBlockr 的精神继承者,专为 ST4 重写,支持 Python/JS/TS/PHP/C++,能对接 LSP(如 pylsp 或 typescript-language-server)获取语义信息。

Sublime Text Build Linux版
Sublime Text Build Linux版

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

下载
  • 打开命令面板(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 模式再试

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

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

ST3 用户若坚持用 DocBlockr,这些坑绕不开

它只对 function foo(a, b) 这类写法有效,const foo = (a, b) => {} 或解构参数 function bar({ id }) 会漏字段甚至不触发。

  • 光标必须严格位于函数正上方的**空行**——该行不能有空格、制表符、注释,前面也不能有空行
  • 输入 /** 后必须立刻按 Enter(不是 Tab),否则不展开
  • 中文 Windows 用户若见 @author 显示方块,检查 fallback_encoding 是否设为 "UTF-8"
  • JS 中箭头函数、Babel 插件、Emmet 都可能劫持快捷键,建议临时禁用其他插件验证

真正卡住人的从来不是“怎么装”,而是装完没反应时不知道该查语法模式、光标位置、版本兼容性,还是模板语法——这几个点串起来,基本覆盖 90% 的失败场景。DoxyDoxygen 的配置项虽多,但只要模板里别混用 $ 符号,js_extract_destructured_params 这类开关记得开,就能稳住大部分真实项目需求。

相关文章

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

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

下载

相关标签:

sublime text sublime

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

相关专题

更多
OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

2026.10.16

60

10

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

2026.10.16

40

10

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

2026.10.16

40

10

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

2026.10.16

20

15

Revel框架MVC路由与控制器
Revel框架MVC路由与控制器

本专题聚焦Revel框架MVC核心机制,讲解路由定义、控制器Action、参数绑定、请求响应和反向路由,并结合常见场景梳理接口请求处理流程。

2026.10.16

20

15

Revel框架入门与安装配置
Revel框架入门与安装配置

本专题从Revel框架环境搭建讲起,系统介绍命令行工具安装、项目创建、目录结构、配置文件及热代码重载,帮助开发者快速完成首个Go Web应用。

2026.10.16

20

15

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

2026.10.15

40

20

MySQL 忘记密码怎么办
MySQL 忘记密码怎么办

MySQL忘记密码专题汇集不同版本与系统下的root密码重置方法,覆盖MySQL 5.7、8.0、Mac、Linux及本地集成环境,并提示恢复权限与重新登录的检查步骤。

2026.10.15

40

18

Vue.js 中 ref 和 reactive 的区别
Vue.js 中 ref 和 reactive 的区别

Vue.js中ref和reactive的区别专题汇集两种响应式API的定义、访问方式、对象解构、侦听与性能取舍等文章,帮助结合实际状态类型选择合适写法。

2026.10.15

20

20

热门下载

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

精品课程

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