Sublime Text安装高级注释框生成器DocBlockr步骤

阿伟大大_1854

阿伟大大_1854

2026-09-21

119人浏览

原创

docblockr在sublime text 4上已停止维护,安装失败或注释无效;应改用专为st4重写的doxydoxygen,它支持多语言、lsp集成,并需注意模板语法(jinja2)、键位冲突及配置项适配。

sublime text安装高级注释框生成器docblockr步骤

Sublime Text 4 上直接装 DocBlockr 会失败或生成空注释,不是你操作错了,是插件本身已停止维护 —— 官方仓库明确标为 unmaintained,且与 ST4 的异步 API 和 Python 3.8+ 运行时不兼容。

为什么 DocBlockr 在 ST4 上装不上或按 Ctrl+Shift+D 没反应

常见现象包括:Package Control 搜索不到 DocBlockr;手动 clone 到 Packages/ 目录后,按 Ctrl+Shift+D(Windows)无响应;控制台报错 AttributeError: 'NoneType' object has no attribute 'groups'

根本原因是:

  • ST4 默认启用 sublime_lib 和异步插件加载,而 DocBlockr 依赖旧版同步 TextCommand 行为
  • 它调用的 view.substr(view.word(point)) 在 ST4 中可能返回空字符串,导致正则解析崩溃
  • inspect.getargspec 已在 Python 3.8+ 被弃用,插件内部未适配,抛出 ValueError

ST4 正确安装替代插件 DoxyDoxygen

它是 DocBlockr 的精神继承者,专为 ST4 重写,支持 Python/JS/PHP/C++,能结合 LSP(如 pylsp)提取真实类型信息。

Sublime Text Build Linux版
Sublime Text Build Linux版

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

下载

安装步骤:

  • 打开命令面板:Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(macOS)
  • 输入 Package Control: Install Package 并回车
  • 搜索 DoxyDoxygen,选中并回车安装
  • 安装后无需重启,但需确保当前文件语法识别正确(右下角显示 JavaScriptPython,不是 Plain Text

触发注释和关键配置项

把光标放在函数定义行(例如 def fetch_user(id: int) -> dict:),按 Ctrl+Alt+D(Windows/Linux)或 Cmd+Alt+D(macOS)即可生成。

常用配置在 Preferences → Package Settings → DoxyDoxygen → Settings 中修改:

  • doxy_doxygen_comment_trigger 设为 "/**""///",避免和已有风格冲突
  • JS 解构参数(如 (options = { timeout: 5000 }))需开启 js_extract_destructured_params
  • 自定义模板时,变量写法必须是 {param.name},不是 ${1:param};循环要用 {% for param in params %}...{% endfor %}
  • @return 行要加 {% if return_type %}...{% endif %},否则函数无返回值时整行被跳过

模板语法、参数提取逻辑、LSP 集成方式这三块最容易漏配,尤其是从 DocBlockr 迁移过来时,变量名和条件语法不兼容,直接复制旧模板会导致生成失败或字段丢失。

相关文章

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

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

下载

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

相关专题

更多
Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

2026.09.21

0

20

NumPy随机数文件读写与dtype数据类型
NumPy随机数文件读写与dtype数据类型

本专题整理 NumPy 随机数、文件读写与 dtype 数据类型相关教程,覆盖 Generator/random、随机数种子、正态分布采样、npy/npz/CSV/TXT 保存读取、loadtxt/savetxt、memmap、大文件处理、astype 类型转换、结构化 dtype、整数溢出和精度丢失等场景。

2026.09.21

0

24

NumPy矩阵运算与线性代数计算
NumPy矩阵运算与线性代数计算

本专题整理 NumPy 矩阵运算与线性代数计算相关教程,覆盖矩阵乘法、dot 与 @ 运算符、逆矩阵、行列式、特征值与特征向量、SVD、线性方程组、欧氏距离、矩阵分解和大规模矩阵性能优化等内容,帮助读者掌握 np.linalg 与矩阵计算实战。

2026.09.21

0

20

NumPy广播机制数学运算与统计分析
NumPy广播机制数学运算与统计分析

本专题整理 NumPy 广播机制、数组数学运算与统计分析相关教程,覆盖广播规则、维度对齐、矩阵与数组加减除法、向量化计算、均值方差、分位数、中位数、直方图和 unique 频次统计等场景,帮助读者掌握 ndarray 高效计算与统计处理方法。

2026.09.21

0

17

NumPy数组创建索引切片与数据选择
NumPy数组创建索引切片与数据选择

本专题整理 NumPy 数组创建、索引、切片与数据选择相关教程,覆盖 np.array、zeros/ones、多维数组形状、基础切片、花式索引、布尔索引、条件筛选、视图与副本等常用场景,帮助读者系统掌握 ndarray 数据构造与高效提取方法。

2026.09.21

0

12

Aionclaw智能助手介绍
Aionclaw智能助手介绍

本专题汇总了AionClaw(AI龙虾助手)的功能介绍与在线使用入口。AionClaw是杭州趣猿人工智能有限公司推出的桌面级AI智能体,能直接在电脑上读写文件、运行脚本、操作浏览器,自动交付Word、PPT、Excel等成品。

2026.09.20

20

13

AionClaw AI智能体与电脑自动化任务执行功能使用教程
AionClaw AI智能体与电脑自动化任务执行功能使用教程

AionClaw专题整理AI智能体与电脑自动化相关功能使用教程,涵盖安装部署、AI任务执行、Skills技能、文件处理、浏览器控制、电脑操作、持久记忆、聊天工具连接以及办公、编程和内容创作等功能,帮助用户快速掌握AionClaw的实际使用方法。

2026.09.20

0

15

AI视频生成软件推荐
AI视频生成软件推荐

本专题汇总了当前主流的AI视频生成软件推荐与排行榜单,涵盖seko、AniShort、剧云、Lovart、LiblibAI及立刻mv等热门工具。同时整理了各软件在文生视频、图生视频、时长限制、画质表现及免费额度等方面的差异对比,助您快速选对适合创作需求的AI视频生成工具。

2026.09.16

200

9

ai生成视频的工具免费版合集
ai生成视频的工具免费版合集

本专题汇总了当前免费AI生成视频工具的排行榜与推荐清单,涵盖seko、讯飞智作、AniShort及剧云、Lovart等多模型集成平台。同时整理了各工具的免费额度、输出时长、水印政策及适用场景差异,助您快速选择合适工具开启AI视频创作。

2026.09.16

100

10

热门下载

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

精品课程

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