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

UP简历
UP简历

基于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 注释是否真在生效范围内。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

751

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

636

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

758

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

618

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1262

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

577

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

706

2023.08.11

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

34

2026.01.14

热门下载

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

精品课程

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

共14课时 | 0.8万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

CSS教程
CSS教程

共754课时 | 18.9万人学习

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

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