怎么让VSCode高亮显示TODO注释_VSCode TODO Highlight待办标记插件教程

浅芳大大_6866

浅芳大大_6866

2026-04-29

902人浏览

原创

todo highlight 插件默认仅识别 todo/fixme/xxx 且不支持 .vue/.md/.json 等文件,需手动配置 keywords、languages 及正则;插件未启用、设置覆盖或字段名错误(如 todohighlights.keywords 写成 todo.highlight.keywords)是常见原因。

怎么让vscode高亮显示todo注释_vscode todo highlight待办标记插件教程

TODO 注释默认不会高亮,装了 TODO Highlight 插件也不行——根本原因不是插件没装对,而是它默认只认 TODO、FIXME、XXX 这三个词,且不自动扫描 .vue、.md 或 .json 等非标准语言文件。

为什么装完插件后 // TODO 还是灰色?

最常见原因是插件未启用,或被工作区设置覆盖。检查右下角状态栏是否显示“TODO Highlight”字样;若无,说明插件根本没加载。

确认方式:按 Ctrl+Shift+P 输入 TODO: List,如果命令不可用,插件大概率处于禁用状态。

  • 打开扩展面板(Ctrl+Shift+X),搜 TODO Highlight,确认作者是 wayou,右侧按钮显示“已启用”
  • 检查 .vscode/settings.json 是否有 "todo.highlight.isEnable": false 这类显式禁用项
  • 重启 VSCode 后再试——某些版本插件需完整重载才能挂载到 TextDocument API

如何让 REVIEW / BUG / HACK 也高亮?

插件默认关键词列表是硬编码的,自定义标记必须手动加进 todo.highlight.keywords(旧版)或 todoHighlights.keywords(2026 年起主流版本)。字段名错一个字母就完全失效。

打开 Preferences: Open Settings (JSON),插入如下结构(注意:不是数组直接写字符串,而是对象数组):

"todoHighlights.keywords": [
  {"text": "TODO", "color": "#ff8c00"},
  {"text": "FIXME", "color": "#ff3b30"},
  {"text": "REVIEW", "color": "#007acc"},
  {"text": "BUG", "color": "#ff2d55"},
  {"text": "HACK", "color": "#ff6b6b"}
]
  • text 值必须全大写、无空格、无标点;// REVIEW: 和 # BUG 都能匹配,但 // review 不会触发
  • 若用的是较老版本插件(如 2024 年发布的),字段名可能是 todo.highlight.keywords,可两个都试一遍
  • 保存后无需重启,但已打开的文件要手动重新打开一次才能刷新高亮

为什么 .vue / .md / .json 里的 TODO 不高亮?

TODO Highlight 默认只扫描 javascript、typescript、python 等语言 ID 对应的文件,.vue 被识别为 vue,.md 是 markdown,.json 是 json —— 这些都不在默认白名单里。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

补全语言支持只需一行配置:

"todoHighlights.languages": ["javascript", "typescript", "python", "vue", "markdown", "json"]
  • .vue 文件必须确保右下角状态栏显示“Vue”而非“HTML”,否则插件按 html 处理,得把 html 也加进去
  • .md 中的代码块(如 ```js)默认不扫描,因为插件只处理注释上下文;若真需要扫代码块里的字符串字面量,得额外配 todoHighlights.include 加 "**/*.md" 并配合正则
  • .json 文件本身无注释语法,但若用了 .jsonc,语言 ID 是 jsonc,需单独加入列表

高亮了但点击跳转光标停在 // 上而不是文字开头?

这是正则捕获组写错的典型表现。插件靠正则提取关键词后的描述文本作为跳转锚点,如果正则把 // 或 # 也包进捕获组,光标就会落在注释符号上。

默认正则一般没问题,但一旦你自定义了 todoHighlights.regex,就极易出错。例如错误写法:

/(//|#)\s*(TODO|FIXME|REVIEW)/

这个正则会把 // 和 TODO 一起捕获为第 1 组,导致跳转位置偏移。

  • 正确写法应只捕获 tag 后的内容,比如:/(//|#)\s*(TODO|FIXME|REVIEW):?\s+(.*)$/,其中 (.*) 是第 3 组,才是跳转目标
  • 如果你没动过正则,却出现跳转错位,大概率是其他插件(如 Better Comments)干扰了注释解析顺序
  • 临时验证方式:删掉所有自定义 regex 配置,仅保留 keywords 和 languages,看是否恢复

真正麻烦的不是配不配得出来,而是不同项目用不同插件(Todo Tree 和 TODO Highlight 配置字段名、正则逻辑、语言识别策略全都不一样),一换项目就得重调一遍。建议团队统一用 Todo Tree 并把 .vscode/settings.json 提交进仓库,避免每人配一套。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1315

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2772

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1949

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1727

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2607

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1818

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1242

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1116

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

474

5

热门下载

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

精品课程

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