使用Sublime正则表达式快速提取代码中的API注释

阿枫大大_1920

阿枫大大_1920

2026-09-01

506人浏览

原创

sublime text 默认正则不支持跨行匹配,因 . 不匹配换行符,需显式用 \n 和 ^$ 锚点分步匹配多行注释;jsdoc 用 ^/\*\*$\n(^ *.*$\n)*^*/$,python docstring 需按缩进分行处理。

使用sublime正则表达式快速提取代码中的api注释

为什么 Sublime 的正则查找不能直接跨行匹配注释?

因为 Sublime Text 默认的 .* 不匹配换行符,而 API 注释(如 JSDoc 或 Python docstring)往往跨多行。即使你写了 /\*\*[\s\S]*?\*/ 这类看似能跨行的正则,Sublime 也不支持 [\s\S] 或 . 匹配换行——它只认 \n 和 \r 显式表达。

用 ^ 和 $ 配合多行模式提取 JSDoc 块

Sublime 支持「多行模式」(即启用 . matches newline 选项,快捷键 Alt+R → 勾选 . matches newline),但更稳定的做法是用行首/行尾锚点配合换行符显式控制:

  • 匹配完整 JSDoc 块(以 /** 开头、*/ 结尾):/\*\*([^*]|\*[^/])*\*/,但这个在 Sublime 中仍可能断在换行处
  • 实际可靠写法是分三步:先定位起始行 ^/\*\*$,再匹配中间任意非结尾行 ^ \*.*$(注意空格和星号),最后匹配结尾行 ^\*/$
  • 把这三行粘成一个正则,用 \n 连接:^/\*\*$\n(^ \*.*$\n)*^\*/$,并确保启用了 Regular expression 和 Match case(视需求)
  • 替换时用 $0 保留原内容,或用 $1 提取中间描述(需加捕获组,如 ^/\*\*$(\n^ \*(.*)$)+\n^\*/$)

Python docstring 提取要小心缩进和引号嵌套

Sublime 对三重引号字符串的正则支持有限,无法处理引号嵌套或转义引号。直接搜 """[\s\S]*?""" 会失败;必须按行处理:

PhotoStudio AI
PhotoStudio AI

PhotoStudio AI是虹软科技推出的电商 AI 智能商拍服务平台。

下载
  • 匹配单行 docstring:^ {4,}""".*?"""$(假设缩进至少 4 空格)
  • 匹配多行 docstring 起始:^ {4,}"""$
  • 中间行要求以相同缩进 + 可选空格 + 内容:^ {4,} .*?$
  • 结尾行必须严格匹配缩进 + """:^ {4,}"""$
  • 把这三者串起来时,注意 Sublime 的 Find All(Alt+Enter)比 Find 更容易选中整块;否则它可能只停在第一行

导出结果时别漏掉换行符和上下文

用 Find All 选中所有匹配后,复制出来是纯文本,但 Sublime 不会自动补上原始文件中的换行风格(\r\n vs \n)。如果后续要粘贴回代码或生成文档:

  • 确认当前文件换行符类型:菜单 File → Line Endings 查看是 Unix (LF) 还是 Windows (CRLF)
  • 替换时若用 $0\n 添加分隔,要手动补对换行符,比如 Windows 下写 $0\r\n
  • 导出前建议先 Ctrl+Shift+P → Copy as Plain Text,避免富文本格式污染
  • 如果注释里有 HTML 标签或 Markdown(如 @param),Sublime 正则不解析语义,只做字面匹配——别指望它自动结构化字段

真正麻烦的是混用风格的项目:有的地方用 /**,有的用 ///,还有的用 # 行注释堆成 API 描述。这种得先统一规范,再写正则——没有万能模式,只有针对当前代码库调出来的那一条能用的表达式。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

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

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

2023.06.20

4356

8

正则表达式不包含
正则表达式不包含

正则表达式,又称规则表达式,,是一种文本模式,包括普通字符和特殊字符,是计算机科学的一个概念。正则表达式使用单个字符串来描述、匹配一系列匹配某个句法规则的字符串,通常被用来检索、替换那些符合某个模式的文本。php中文网给大家带来了有关正则表达式的相关教程以及文章,希望对大家能有所帮助。

2023.07.05

2881

4

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7922

9

java正则表达式匹配字符串
java正则表达式匹配字符串

在Java中,我们可以使用正则表达式来匹配字符串。本专题为大家带来java正则表达式匹配字符串的相关内容,帮助大家解决问题。

2023.08.11

812

5

正则表达式空格
正则表达式空格

正则表达式空格可以用“\s”来表示,它是一个特殊的元字符,用于匹配任意空白字符,包括空格、制表符、换行符等。本专题为大家提供正则表达式相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.31

520

5

Python爬虫获取数据的方法
Python爬虫获取数据的方法

Python爬虫可以通过请求库发送HTTP请求、解析库解析HTML、正则表达式提取数据,或使用数据抓取框架来获取数据。更多关于Python爬虫相关知识。详情阅读本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

673

12

正则表达式空格如何表示
正则表达式空格如何表示

正则表达式空格可以用“\s”来表示,它是一个特殊的元字符,用于匹配任意空白字符,包括空格、制表符、换行符等。想了解更多正则表达式空格怎么表示的内容,可以访问下面的文章。

2023.11.17

386

3

正则表达式中如何匹配数字
正则表达式中如何匹配数字

正则表达式中可以通过匹配单个数字、匹配多个数字、匹配固定长度的数字、匹配整数和小数、匹配负数和匹配科学计数法表示的数字的方法匹配数字。更多关于正则表达式的相关知识详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.12.06

719

7

php正则表达式有哪些
php正则表达式有哪些

php正则表达式有"/pattern/"、"^"、"$"、"."、"[]"、"[^]"、"[a-z]"、"[A-Z]"、"[0-9]"、"\d"、"\D"、"\w"、"\W"、&a

2024.02.23

312

5

热门下载

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

精品课程

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