如何通过 String.prototype.matchAll() 实现对原始文本中所有特定格式注释的聚合

小枫同学_9050

小枫同学_9050

2026-05-03

148人浏览

原创

matchall() 是处理多匹配、带捕获组正则的理想选择,可高效提取并结构化注释(如 // todo、/ hack /、{@warn}),返回含完整捕获信息的可迭代对象,避免 exec() 循环的繁琐与错误。

如何通过 string.prototype.matchall() 实现对原始文本中所有特定格式注释的聚合

matchAll() 是处理多匹配、带捕获组的正则场景的理想选择,特别适合提取并聚合结构化注释(如 // TODO、/* FIXME */、{@note ...} 等)。它返回一个可迭代对象,能完整保留每次匹配的全部信息(含捕获组),避免手动循环 exec() 的繁琐和易错。

明确注释格式并编写带捕获组的正则

聚合的前提是统一识别逻辑。例如,若需提取三类常见注释:

  • // TODO: 重构缓存逻辑 → 匹配行内单行注释
  • /* HACK: 避免 Safari flex bug */ → 匹配块级注释
  • {@warn 忽略空值可能导致崩溃} → 匹配 JSDoc 风格标记

可构造一个「或」式正则,并为关键部分(类型、内容)设置命名捕获组:

const commentRegex = /(?:\/\/\s*(?TODO|FIXME|HACK):?\s*(?[^\n]*))|(?:\/\*\s*(?FIXME|HACK|NOTE):\s*(?[^*]*?)\s*\*\/)|(?:\{@(?warn|note|todo)\s+(?[^}]+)\})/g;

用 matchAll() 提取所有匹配并归一化结构

调用 matchAll() 后,遍历结果,从不同捕获组中提取 type 和 content,统一成标准对象:

const text = `// TODO: 加入错误重试\n/* HACK: 强制重绘 */\n{@warn 不支持 IE11}\nconsole.log('done');`;\n\nconst allComments = [...text.matchAll(commentRegex)]\n .map(match => {\n const { type, content, type2, content2, type3, content3 } = match.groups;\n // 优先取非 undefined 的组\n const kind = type || type2 || type3;\n const body = content?.trim() || content2?.trim() || content3?.trim();\n return { type: kind, content: body, index: match.index };\n });

结果为数组:[{type:"TODO", content:"加入错误重试", index:0}, {...}],已结构化、可排序、可过滤。

按需聚合:分组统计、去重合并或生成报告

得到结构化数组后,聚合方式灵活:

  • 按类型分组:Object.groupBy(allComments, ({type}) => type)(ES2024)或用 reduce
  • 提取唯一内容:[...new Set(allComments.map(c => c.content))]
  • 生成 Markdown 报告:allComments.map(c => `- [${c.type}] ${c.content}`).join('\n')

例如统计各类型数量:
const counts = allComments.reduce((acc, {type}) => {\n acc[type] = (acc[type] || 0) + 1;\n return acc;\n}, {}); // { TODO: 1, HACK: 1, warn: 1 }

注意边界与健壮性

真实文本中需考虑:

  • 注释可能跨行(尤其块注释),此时正则需加 s 标志(/.../gs)使 . 匹配换行符
  • 避免匹配字符串字面量中的伪注释(如 const s = "// TODO: not real";),需结合语法分析器(如 Acorn)更安全;纯正则方案可加负向先行断言排除引号内位置(较复杂,视精度要求取舍)
  • matchAll() 要求正则含 g 标志,否则抛错
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3089

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2288

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1220

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1178

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

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

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

2023.09.20

2118

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3400

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

15335

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习