0

0

Sublime如何管理代码中的TODO、FIXME等标记? (TodoReview插件)

冰火之心

冰火之心

发布时间:2026-01-14 16:41:38

|

700人浏览过

|

来源于php中文网

原创

TodoReview 插件需配置 .todoconfig 文件并以 Project 方式打开文件夹才能启用;自定义 patterns 可扩展 TODO/FIXME 匹配规则并支持忽略大小写;需在 file_extensions 中添加 .vue、.ts 等后缀;跳转偏移常因 BOM、混合缩进或注释格式不规范导致。

sublime如何管理代码中的todo、fixme等标记? (todoreview插件)

Sublime Text 本身不内置 TODO/FIXME 标记的集中管理功能,但通过 TodoReview 插件可以快速扫描、聚合并跳转所有标记——前提是正确配置正则规则和作用范围,否则容易漏扫或误报。

安装 TodoReview 插件后为什么没反应?

常见原因是插件未激活扫描,或项目根目录缺失 .todoconfig 配置文件。默认情况下,TodoReview 只在有该配置文件的项目中启用,且只扫描当前打开的文件夹(project)下的文件。

  • 确保已通过 Package Control 安装 TodoReview,重启 Sublime 后按 Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+PmacOS),输入 TodoReview: Toggle 尝试触发
  • 若无响应,在项目根目录手动创建 .todoconfig 文件(内容可为空,仅需存在)
  • 确认 Sublime 当前是以「Project」方式打开文件夹(File → Open Folder…),而非单独打开多个文件

如何自定义 TODO/FIXME 的匹配规则?

TodoReview 默认识别 TODOFIXMEXXX,但不支持大小写模糊匹配(如 todoFixme),也不包含 NOTEHACK。需修改 TodoReview.sublime-settings 中的 patterns 数组。

  • 打开 Preferences → Package Settings → TodoReview → Settings
  • 在用户设置中覆盖 patterns,例如:
{
  "patterns": [
    "(?i)\b(TODO|FIXME|NOTE|HACK|BUG|XXX)\b"
  ]
}

注意:(?i) 开启忽略大小写,\b 确保匹配单词边界,避免把 TODO_LIST 里的 TODO 单独抽出来

为什么某些文件类型(如 .vue、.ts)里的 TODO 没被扫到?

默认配置只扫描常见后缀(["*.py", "*.js", "*.html", "*.css"]),.vue.ts.jsx 等需要显式加入 file_extensions

DreamStudio
DreamStudio

SD兄弟产品!AI 图像生成器

下载
  • TodoReview.sublime-settings 用户设置中添加:
{
  "file_extensions": ["*.js", "*.ts", "*.jsx", "*.vue", "*.html", "*.py", "*.rb"]
}

注意:不要删掉原有扩展名,否则 Python/HTML 文件也会失效;路径通配符必须带 * 和点号,写成 vue.vue 都无效

扫描结果里跳转失败或定位偏移?

这是最易被忽略的问题:当文件含 BOM、混合缩进(空格+Tab)、或注释格式不标准(如 //TODO: 中冒号紧贴 TODO)时,TodoReview 的行号计算可能错位。

  • 优先统一使用空格缩进,避免 Tab 混入
  • 推荐标准写法:// TODO: 修复登录态失效(冒号后空一格),而不是 //TODO:// TODO: 前多空格
  • 如果某文件总跳转不准,可在 .todoconfig 中临时排除它:"exclude_files": ["dist/*.js"]

正则匹配本身不解析语法结构,所以它本质上是文本扫描器——别指望它理解 TypeScript 接口里的 JSDoc 注释是否真在生效范围内。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

49

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

196

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

65

2026.03.13

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1971

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

658

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2406

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

47

2026.01.19

js正则表达式
js正则表达式

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

531

2023.06.20

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

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

共14课时 | 0.9万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

CSS教程
CSS教程

共754课时 | 43.2万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号