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

Sublime搭配DocBlockr自动生成规范化代码注释

老萱吖_3238

老萱吖_3238

发布时间:2026-07-02 10:11:36

|

227人浏览过

|

来源于php中文网

原创

DocBlockr仅基于正则匹配函数签名生成基础注释模板,不解析AST、不识别类型注解、不处理解构参数/默认值/箭头函数;光标必须位于function/def/class定义行才触发,且依赖正确语法高亮。

sublime搭配docblockr自动生成规范化代码注释

DocBlockr 能自动生成基础注释模板,但**不会自动识别类型、不解析 AST、不处理解构/默认值/箭头函数**——你得先写对函数签名,它才可能填对 @param。

光标位置必须精准到函数定义行

插件只在函数/类声明行(function、def、class 所在行)触发,其他位置无效:

  • ✅ 正确:光标停在 function getUser(id, options) { 这一行任意位置,输入 /** 后回车
  • ❌ 错误:光标在函数体内部、空行中间、或 export default 的 default 上
  • ⚠️ 箭头函数 const fn = (a, b) => {} 默认不识别,得改写成 const fn = function(a, b) {} 或手动补全
  • ? 检查右下角状态栏语法是否为 JavaScript / PHP / Python,不是 Plain Text;否则插件压根不激活

参数提取靠正则,不是靠类型系统

它不读 TypeScript 的 : string、不看 Python 的 -> dict、也不解析 PHP 8 的 string $s 类型声明:

  • function foo({ a }, [b] = []) → 只提取出 { a } 和 [b] = [],不会拆解对象/数组
  • def bar(x: int, y: Optional[str] = None) → 只取 x 和 y,类型提示全丢
  • function baz($id, $with = []) → $with = [] 被当作文本,参数名变成 $with = [],不是 $with
  • ? 补救方式:生成后手动删掉等号部分,或用 Ctrl+Shift+P → DocBlockr: Expand Abbreviation 补默认 @param 模板

自定义模板要改 Settings - User,且不能有语法错误

改了设置没生效?大概率是改错了地方或 JSON 格式崩了:

  • 必须进 Preferences → Package Settings → DocBlockr → Settings - User,不是 Settings - Default
  • "auto_complete": true 开启参数自动填充,"jsdoc_enable_types": true 仅影响 JS 中 @type 标签行为,不等于自动加类型
  • 想让 @param 默认带 {string} 占位符,得重写 jsdocs_function_template 字段,不是靠开关
  • ⚠️ "jsdoc_parse_param_description": true 会尝试从函数体第一行注释(如 // id: user ID)提取描述,但准确率低,容易错配,慎开

最常被忽略的点:它不校验语法正确性,只做文本匹配。一个缩进错、少个括号、多层解构,@param 就可能全空或者乱序——别信自动生成,生成完至少扫一眼参数名是否齐全、顺序是否对得上。

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

DeepSeek

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

WorkBuddy

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

蛙蛙写作

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Lovart
Lovart Hot

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

相关专题

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

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

60

2026.10.16

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

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

40

2026.10.16

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

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

40

2026.10.16

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

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

20

2026.10.16

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

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

20

2026.10.16

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

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

20

2026.10.16

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

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

40

2026.10.15

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

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

40

2026.10.15

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

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

20

2026.10.15

热门下载

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

精品课程

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

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