Sublime Text安装代码智能注释生成插件DocBlockr

雨宇君_8366

雨宇君_8366

2026-07-24

525人浏览

原创

sublime text 4 必须使用 doxydoxygen 替代已废弃的 docblockr,因其专为 st4 重写、支持 lsp 类型推导;安装后需用 ctrl+alt+d 触发,且仅在正确语法类型和函数定义行生效,模板语法基于 jinja2,与 docblockr 不兼容。

sublime text安装代码智能注释生成插件docblockr

Sublime Text 4 装 DocBlockr 会失败,别硬试

DocBlockr 在 Sublime Text 4 上已明确标记为 unmaintained,直接通过 Package Control 搜索安装大概率不出现,或装上后按 /**+Enter 没反应,控制台报错 AttributeError: 'NoneType' object has no attribute 'groups'。这不是你配置错了,是插件底层调用的 Sublime API 已变更,它没法兼容 ST4 的异步加载和新 view.substr() 行为。

ST4 必须换 DoxyDoxygen,不是可选项

DoxyDoxygen 是 DocBlockr 的实际继承者,专为 ST4 重写,支持 Python/JS/PHP/C++,能对接 LSP(比如 pylsp、typescript-language-server)提取真实类型信息,而不是靠正则硬猜。

  • 安装:打开命令面板 Ctrl+Shift+P → Package Control: Install Package → 搜 DoxyDoxygen 并安装
  • 触发方式:光标放在函数定义行(如 def fetch_user(id: int) -> dict:),按 Ctrl+Alt+D(Windows/Linux)或 Cmd+Alt+D(macOS)
  • 注意:/**+Enter 不再有效;DoxyDoxygen 默认不监听 Enter,避免和 Emmet 等插件冲突

模板语法和变量写法全变了,照搬 DocBlockr 配置必出错

DoxyDoxygen 用 Jinja2 模板引擎,变量和循环语法和 DocBlockr 完全不兼容。把旧配置里的 ${1:description} 或 ${params} 直接粘过去,注释块会渲染为空或报错。

Sublime Text Build Linux版
Sublime Text Build Linux版

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

下载
  • @param 循环必须写成:{% for param in params %}@param {param.type} {param.name}{% endfor %}
  • 想让 @return 只在有返回值时出现,得加判断:{% if return_type %}@return {return_type}{% endif %}
  • 解构参数(如 (options = { timeout: 5000 }))要生效,必须在设置里开 "js_extract_destructured_params": true

光标位置和文件语法类型决定能不能生成,不是插件问题

即使装对了插件,Ctrl+Alt+D 没反应,90% 是这两个原因:

  • 右下角状态栏显示的是 Plain Text,不是 JavaScript 或 Python —— 点它手动切换,或用 Ctrl+Shift+P → Set Syntax: JavaScript
  • 光标没放在函数定义行:不能在函数体内、不能在 export default 的 default 上,必须在 function、def、const 所在整行任意位置
  • 箭头函数 const fn = (a, b) => {} 默认不识别;改用 const fn = function(a, b) {} 或启用 jsdocs_allow_function_declarations(DoxyDoxygen 中对应配置项名不同,需查文档)

最常被忽略的是:DoxyDoxygen 的模板里写 {return_type},但函数没标注返回类型(比如 JS 里没 JSDoc @returns,Python 里没 -> str),那一行就彻底消失——不是 bug,是设计如此。想强制显示,得自己加 {% if return_type %}...{% else %}@return void{% endif %}。

相关文章

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

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

下载

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

相关专题

更多
LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

2026.09.30

80

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

80

14

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

40

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

40

26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

2026.09.29

60

15

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

280

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

160

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

120

15

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

2026.09.22

80

12

热门下载

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

精品课程

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