跳转到主内容
极星编程网:以代码为星,赴技术山海!

Sublime Text TodoReview怎么用_Sublime Text TODO高亮教程【秒懂】

TodoReview 无反应的主因是未以项目方式打开文件夹且缺少 .todoconfig 文件;关键词匹配需用 patterns 正则而非 keywords;高亮需 Highlight 插件或主题支持;扫描慢须配置 file_patterns 和 folder_exclude_patterns。 TodoReview 安装后没反应?先检查项目打开方式和
.todoconfig
Sublime Text 的 TodoReview 插件默认只在「以项目方式打开文件夹」时激活,单独打开几个文件或用「Open File」打开单个文件,插件根本不会扫描——这是最常被忽略的启动前提。 必须通过
File → Open Folder…
打开整个项目根目录,不能只是拖入文件 项目根目录下需存在一个空文件
.todoconfig
(文件名带点,无后缀),否则插件静默不工作 安装完插件后不用重启 Sublime,但要确保 Package Control 已提前装好;若命令面板里搜不到
TodoReview: Show
,大概率是没打开项目或缺
.todoconfig
关键词匹配不到 TODO/FIXME?正则配置比
keywords
列表更可靠 很多人改了
"keywords": ["TODO", "FIXME"]
就以为万事大吉,结果注释里写
// TODO: 重构缓存逻辑
还是不识别——因为默认匹配逻辑只认独立单词(
TODO
),而冒号、空格、中文标点会打断匹配。 推荐直接用
patterns
配置正则,例如:
{ "patterns": { "todo": "(?i)TODO[::]\s*", "fixme": "(?i)FIXME[::]\s*" }, "pattern_names": ["todo", "fixme"] }
(?i)
表示忽略大小写,
[::]
同时兼容英文冒号和中文顿号,
\s*
吃掉后面任意空白,匹配更鲁棒 避免把
case_sensitive
设为
true
,除非团队强制全大写规范;小写
todo
在 Markdown 或注释块中很常见 为什么高亮不明显?Sublime 默认不给 TODO 上色,得靠额外插件或主题支持 TodoReview 本身只负责“找”和“列”,不控制颜色。你在代码里看到的灰色 TODO,其实是普通注释色——它没被赋予独立作用域(如
keyword.other.todo
),所以换再好的主题也没用。 仿Sublime和notepad++编辑器效果 仿Sublime和notepad++编辑器效果 下载 最快方案:装
Highlight
插件,在
Preferences → Package Settings → Highlight → Settings - User
里加
{ "highlights": [{ "name": "todo_fixme", "scope": "comment", "regex": "\b(TODO|FIXME)\b", "style": "fill", "color": "hsl(45, 100%, 70%)" }] }
如果已用 Monokai、Ayucia 等主题,先试切换主题看是否自带
keyword.other.todo
支持;没有的话,手动改
.tmTheme
文件成本高,不建议新手折腾 别指望
Find All
的临时高亮替代长期方案——它不持久、不跨文件、不联动跳转 扫描慢或漏文件?重点调
file_patterns
和
folder_exclude_patterns
默认设置会扫所有文本文件,包括
node_modules
、
.git
、
dist
下的压缩 JS,不仅卡顿,还堆满无效条目。 在
TodoReview → Settings
中明确限定范围:
{ "file_patterns": ["*.py", "*.js", "*.ts", "*.vue", "*.html"], "folder_exclude_patterns": [".git", "node_modules", "dist", "__pycache__"] }
*.vue
、
*.ts
这类后缀必须显式加上,否则 Vue 单文件组件里的