0

0

sublime怎么安装DocBlockr插件_sublime快速生成注释【经验】

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-03-16 08:30:01

|

136人浏览过

|

来源于php中文网

原创

DocBlockr 在 Sublime Text 4 中无法使用,因其基于已淘汰的 Python 2;应安装社区维护的 docblockr-python3 分支,支持 JS/TS/Python 等语言,但不识别解构参数、箭头函数及复杂类型,需手动补全 @param 和 @returns。

sublime怎么安装docblockr插件_sublime快速生成注释【经验】

DocBlockr 在 Sublime Text 4 里根本不能用

Sublime Text 4 已经移除了对 Python 2 插件的支持,而原版 DocBlockr 是基于 Python 2 写的,直接安装会失败或不响应。你按教程装完没反应,不是操作错,是插件本身已过期。

  • 官方仓库 docblockr(作者 Nasci)早在 2019 年就停止维护,最后一次提交针对 ST3
  • ST4 启动时会静默跳过不兼容插件,不会报错,但 /** 回车后毫无反应
  • 别试 Package Control: Install PackageDocBlockr——装上也白装

替代方案:用 DocBlockr 的现代分支 docblockr-python3

社区有人把原插件迁移到 Python 3,并适配了 ST4 的 API,名字叫 docblockr-python3,目前是唯一能正常工作的继承者。

  • Package Control: Install Package 里搜 docblockr-python3(注意中间有短横,不是 docblockr
  • 装完重启 Sublime,打开一个 .js.py 文件,输入 /** 然后回车,应该立刻生成带参数占位符的注释块
  • 它支持的语言默认包括:javascripttypescriptpythonphpjava;其他语言需手动配置 doc_block_language_map
  • 如果回车没反应,检查是否被其它插件干扰(比如 Emmet 抢占了 TabEnter 快捷键)

自定义函数注释模板要改 settings 文件,不是改插件源码

很多人想改“作者”“@returns”格式,直接去插件目录改 .py 文件,结果下次更新就覆盖了,而且容易出语法错误。

Gambo
Gambo

世界上首个游戏氛围编程智能体

下载
  • 正确做法:菜单栏 Preferences → Package Settings → docblockr-python3 → Settings
  • 在右侧用户设置里加字段,例如:
    "jsdoc_indentation": 2,
    "jsdoc_extra_tags": ["@since", "@example"]
  • template 字段可完全重写,但注意变量用 ${name} 格式,不是 {{name}};漏掉 ${description} 会导致光标卡住
  • 改完保存,不用重启,但已有打开的文件需要重新触发(删掉注释重输 /**

JS/TS 里解构参数或箭头函数,DocBlockr 不识别,得手动补

这是最常踩的坑:你写 const fn = ({ a, b }) => {}function foo([x, y])docblockr-python3 生成的 @param 仍然是空的,或者只写出 {}[] 占位符,不会自动展开内部字段。

  • 它依赖 AST 解析函数签名,但当前版本不处理解构、默认值、泛型等复杂 JS 语法
  • 遇到 async 函数、带重载的 TS 接口,同样无法推导参数类型,@param 行得手填
  • 别指望它生成 @returns {Promise<number>}</number> —— 返回类型必须自己写,插件只负责格式和缩进
  • 如果项目重度使用 TS,建议搭配 ESLint + @typescript-eslint/explicit-function-return-type 来兜底,而不是依赖注释生成
实际用起来,最麻烦的从来不是装不上,而是生成了半截注释还信以为真。尤其团队里有人靠它写文档,结果解构参数全没写,PR 里还得挨个补。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

49

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

199

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

90

2026.03.13

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

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

564

2023.09.20

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1998

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

681

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2418

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

49

2026.01.19

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

69

2026.03.13

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号