VSCode如何使用TODO Highlight高亮待办事项

风辰小哥_1989

风辰小哥_1989

2026-05-07

753人浏览

原创

todo highlight 插件默认仅识别大写紧贴注释符的 todo/fixme/xxx;关键词不生效主因是字段名错误(应为 todohighlights.keywords 而非 todo.highlight.keywords),且需正确配置 languages 和 include 才支持 .vue/.md 文件。

vscode如何使用todo highlight高亮待办事项

TODO Highlight 插件默认只高亮 TODO、FIXME、XXX 这三个大写、紧贴注释符的词,其他形式(比如小写、带空格、带冒号、写在 .vue 或 .md 里)基本不会触发——不是插件坏了,是它根本没扫到。

为什么改了 keywords 还不生效

最常见原因是字段名写错或被覆盖:todo.highlight.keywords 是旧版字段名,2026 年多数用户实际用的是 todoHighlights.keywords(注意中间没有点)。VSCode 设置里一旦拼错一个字母,整个配置就静默失效。

  • 打开命令面板 Ctrl+Shift+P → 输入 Preferences: Open Settings (JSON)
  • 确认你加的是 "todoHighlights.keywords",不是 "todo.highlight.keywords" 或 "todo.keywords"
  • 检查项目根目录下是否有 .vscode/settings.json,它会覆盖全局设置;临时重命名该文件测试是否恢复
  • 关键词必须是对象数组,每个对象含 text 字段,例如:{"text": "REVIEW", "color": "#007acc"},不能只写字符串 "REVIEW"

为什么 .vue / .md 文件里不亮

TODO Highlight 默认跳过非编程语言文件,.vue 单文件组件会被识别为 vue 语言,但前提是 VSCode 右下角状态栏显示的是 Vue(不是 HTML);.md 文件里的代码块也不会扫,因为插件默认只处理注释上下文,不解析字符串字面量。

VSCode
VSCode

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

下载
  • 在 settings.json 中补全 "todoHighlights.languages":值设为 ["javascript", "typescript", "vue", "markdown"]
  • 确保 .vue 文件右下角语言模式是 Vue;如果不是,点击切换,或在文件顶部加 // @ts-check 等提示语帮 VSCode 推断
  • 想让 .md 中的 <!-- TODO --> 或代码块内文本也被扫描,得加 "todoHighlights.include": ["**/*.md"],并确认 languages 包含 markdown

高亮了但光标跳转错位(停在 // 上)

这是正则捕获组没对齐导致的。插件靠正则提取关键词后的文字内容作为跳转锚点,如果正则把注释符号也包进去了,光标就落偏了。默认正则通常没问题,但一旦你自定义了 todoHighlights.regex,就很容易踩坑。

  • 除非必要,别动 regex 配置;优先用 keywords 数组方式扩展
  • 如果必须用正则,确保只捕获 tag 后的文字部分,例如:/(//|#)\s*(TODO|FIXME):?\s+(.*)$/,其中 (.*) 是第 3 组,才是跳转目标
  • 避免写成 /(// TODO)/ 这种全匹配式正则,它会把 // 一起捕获,导致光标卡在斜杠上

真正麻烦的不是配不配得出来,而是不同项目里 .vscode/settings.json 和全局 settings.json 的字段名、路径、语言列表经常混着用,稍不注意就互相压制。建议先清掉所有 todo 相关字段,从最简配置起步:todoHighlights.keywords + todoHighlights.languages + todoHighlights.include,再逐步加颜色和正则。

相关文章

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

1175

18

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

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

2023.07.21

2392

3

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

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

2024.03.14

1829

12

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

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

2024.03.14

1687

8

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

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

2024.03.15

2567

12

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

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

2024.03.15

1798

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1222

10

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

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

2024.03.15

1096

8

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

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

2024.03.15

414

5

热门下载

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

精品课程

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