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

Sublime实现一键生成API文档 安装DocBlockr插件

阿婷吖_7352

阿婷吖_7352

发布时间:2026-04-15 13:57:16

|

987人浏览过

|

来源于php中文网

原创

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

sublime实现一键生成api文档 安装docblockr插件

Sublime Text 4 用户直接装 DocBlockr 基本会失败或生成空注释,它已停止维护,且不兼容 ST4 的 API 和异步加载机制;ST3 用户也需注意 Python 3.8+ 下 inspect.getargspec 被弃用导致崩溃。真要一键生成 API 文档,得换插件、调配置、改模板,不是装完就完事。

ST4 用户别碰 DocBlockr,改用 DoxyDoxygen

官方仓库明确标为 “unmaintained”,在 ST4 上安装后按 Ctrl+Alt+D(Windows/Linux)或 Cmd+Alt+D(macOS)没反应,控制台报 AttributeError: 'NoneType' object has no attribute 'groups' 是典型症状。这不是你操作错,是插件底层解析逻辑在新 API 下直接崩了。

  • 打开命令面板 → Package Control: Install Package → 搜 DoxyDoxygen(注意拼写,不是 DocBlockr)
  • 装完无需重启,但必须确保当前文件语法模式正确(右下角显示 JavaScript 或 Python,不能是 Plain Text)
  • 光标放在函数定义行(如 function getUser(id) { 或 def create_order(items):),按快捷键触发,不是敲 /** 回车
  • 若用 TypeScript 或 Babel 插件,可能覆盖语法高亮,临时切回原生模式再试

ST3 用户还能用 DocBlockr,但得卡准触发位置和语法

它只在极有限条件下工作:函数必须用 function 关键字声明(const fn = () => {} 不识别),参数不能是解构(({ a, b }) 会漏掉),且光标必须严格位于函数正上方的空行——前面有空格、制表符、甚至注释都不行。

  • 输入 /** 后立刻按 Enter(不是 Tab),否则不展开
  • 检查右下角语言模式:JS 文件被识别成 HTML 或 Plain Text 时,DocBlockr 完全静默
  • 如果按 Tab 没反应,去 Preferences → Key Bindings 搜 docblockr,确认快捷键没被 Emmet 或其他插件劫持
  • 中文 Windows 用户若见乱码字段(如 @author 显示方块),检查 fallback_encoding 是否设为 "UTF-8"

自定义 API 文档模板时,变量语法和条件判断必须重写

DoxyDoxygen 用 Jinja2 语法,和 DocBlockr 的 ${1:description} 完全不兼容。直接复制旧模板会导致字段消失、整行跳过,甚至模板解析失败。

  • @param 循环必须写成:{% for param in params %}@param {param.type} {param.name}{% endfor %}
  • 想让 @return 在无返回值时也显示,得包一层判断:{% if return_type %}@return {return_type}{% endif %}
  • 模板里所有变量去掉了 $ 和序号,比如 {description},不是 ${1:description}
  • JS 解构参数(如 (options = { timeout: 5000 }))要提取 options.timeout,必须开启配置项 js_extract_destructured_params

真正卡住人的从来不是“怎么装”,而是哪几处一错就全废

装完插件发现没反应,90% 情况不是插件问题,而是三个点串错了:语法模式不对 → 触发位置不空 → 函数声明不符合解析规则。ST4 用户还多一层:插件根本跑不起来。模板自定义时最容易忽略的是条件包裹和变量语法切换,看着配置生效了,其实字段早被跳过。这些点不串起来排查,装十遍也没用。

热门AI工具

更多
WorkBuddy

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

豆包大模型

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

UpDream
UpDream Hot

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

DeepSeek

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

相关专题

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

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

3329

2023.06.20

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

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

2368

2023.07.25

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

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

1300

2023.08.02

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

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

1238

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,随机排序。

1376

2023.09.05

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

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

2238

2023.09.20

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

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

3620

2023.09.20

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

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

16735

2023.09.22

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

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

精品课程

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

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