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

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

阿枫大大_1920

阿枫大大_1920

发布时间:2026-09-01 07:18:47

|

506人浏览过

|

来源于php中文网

原创

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]*?""" 会失败;必须按行处理:

  • 匹配单行 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 描述。这种得先统一规范,再写正则——没有万能模式,只有针对当前代码库调出来的那一条能用的表达式。

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

豆包大模型

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

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

DeepSeek

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

WorkBuddy

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

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

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

4356

2023.06.20

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

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

2881

2023.07.05

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

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

7922

2023.07.05

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

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

812

2023.08.11

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

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

520

2023.08.31

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

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

673

2023.11.13

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

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

386

2023.11.17

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

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

719

2023.12.06

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

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

60

2026.10.16

热门下载

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

精品课程

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

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