如何在Sublime Text中用正则替换JSDoc的[]数组语法为Array类型
Sublime Text JSDoc 数组类型正则替换方案
核心设计原则
正则会将匹配范围严格锁定在JSDoc注释块的类型定义区域,完全规避普通业务代码中数组字面量的误匹配。
具体使用配置
打开Sublime查找替换面板(Ctrl+H / Cmd+H),开启正则匹配模式(面板中的.*开关),填入以下配置:
查找正则
(/\*\*[\s\S]*?@(?:param|returns|type|prop|typedef|throws)\s*)(\{[^{}]*?)\[([^\[\]{}]*)\]([^{}]*\})
正则拆解说明:
- 第一部分锚定JSDoc块的起始位置与标签:从
/**注释块开头匹配,定位到@param、@returns等常见JSDoc标签后的类型定义区域,从根源上排除业务代码的匹配可能 - 匹配类型块内部的方括号结构,同时捕获方括号内部的内容(支持空内容、带复杂泛型的类型名两种场景)
- 非贪婪匹配逻辑保证不会跨类型块、跨注释块匹配
替换规则
$1$2Array(?{3}:.<$3>:)$4
替换逻辑说明:
- 自动判断方括号内部是否存在内容:空的方括号
[]直接替换为Array;带类型名的方括号[xxx]自动替换为Array.<xxx> - 完整保留类型块中原有的联合类型分隔符(
|)、前后内容,不破坏原有JSDoc结构
匹配效果验证
目标JSDoc场景替换结果
| 原JSDoc类型片段 | 替换后结果 |
|---|---|
{[]} | {Array} |
{[]|null} | {Array|null} |
{null|[]} | {null|Array} |
{[someType]} | {Array.<someType>} |
{someType|[someType]} | {someType|Array.<someType>} |
业务代码不匹配验证
以下普通JS代码片段不会被正则触发替换:
const thing1 = [something];const thing2 = [];const thing3 = {thang: []};const thing4 = {thang: [something]};
操作提示
执行全量替换前,先点击查找面板的“高亮匹配”按钮,确认所有高亮的匹配内容都是目标JSDoc片段、没有覆盖业务代码,再执行批量替换。
内容的提问来源于stack exchange,提问作者Jordan Simon
相关产品推荐
相关产品推荐

