Sublime Text 的 TODO 高亮仅识别标准 HTML 注释格式 ,因内置语法定义匹配

Sublime Text 里 TODO 注释不亮、高亮错位、或只亮一半,基本不是插件坏了,而是注释格式没对上编辑器的扫描规则——它只认标准 HTML 注释包裹的 TODO,其他写法一律无视。
为什么 才能被识别
Sublime Text 默认的 TODO 高亮逻辑来自内置的 TODO 语法定义(TODO.sublime-syntax 或旧版 TODO.tmLanguage),它用正则匹配形如 (无空格)可能失效,因为正则要求 TODO 前后有空白或边界
-->)会因语法解析冲突导致高亮中断TODO 规则根本不会加载检查并重置当前文件的语法绑定
高亮失效最常见原因是 Sublime 没把当前文件当 HTML/JS/CSS 处理,而是用了 Plain text 或错误的语法。确认和修复方法:
- 看窗口右下角状态栏,显示的是什么?如果是
Plain text,点击它 → 选HTML或对应语言 - 快捷键
Ctrl+Shift+P(Win/Linux)或Cmd+Shift+P(macOS)→ 输入Set Syntax: HTML回车 - 想永久绑定某类后缀(比如
.conf文件也启用 TODO 高亮),在菜单View → Syntax → Open all with current extension as… → HTML - 验证是否生效:新建一个
test.html,写入,看是否立刻高亮
自定义高亮规则(绕过默认限制)
如果你必须在非 HTML 文件(如 .py、.sh、.yml)里用 TODO,又不想改写法,可以手动扩展语法高亮规则:
- 打开
Preferences → Browse Packages…→ 进入User/目录 - 新建文件
TODO-override.sublime-syntax,内容如下(仅适配 Python 示例):
%YAML 1.2
---
name: TODO Override
file_extensions:
- py
scope: source.python
contexts:
main:
- match: '\b(TODO|FIXME|XXX)\b'
scope: todo.keyword
- 保存后,重启 Sublime 或执行
Ctrl+Shift+P → Synchronize syntaxes - 再打开
.py文件,写# TODO: fix this就能高亮了(注意:这里用的是\bTODO\b,不依赖注释符号) - 同理可为
.sh、.yml等添加对应file_extensions和scope
别忽略缓存与插件冲突
即使格式和语法都对,高亮仍异常,大概率是缓存污染或插件抢注了 todo scope:
- 删掉
Packages/User/TODO.sublime-settings(如果存在),它可能覆盖了默认行为 - 临时禁用所有插件:
Preferences → Package Control → Disable Package,逐个排查TodoReview、SublimeLinter等 - 清除语法缓存:关闭 Sublime → 删除
Packages/User/Cache/下所有*todo*和*syntax*文件 → 重启 - 某些主题(如
Material Theme)会重定义todo.keyword的颜色,检查主题设置里有没有"todo" : "..."这类覆盖项
真正麻烦的不是怎么让 TODO 显色,而是当它高亮了,你点开发现那行注释已经三年没更新,而实际逻辑早被重写了——这时候,高亮反而成了干扰源。所以调完显示,顺手 grep 一遍项目里所有











