跳转到主内容
websoft网络软件专家 - 深耕网络技术,打造实用软件!

VSCode的TODO Highlight插件:再也不会忘记待办事项

VSCode 的 TODO Highlight 插件可通过高亮、跳转和自定义关键词等方式强化 TODO/FIXME 等标记提示;支持安装启用、关键词扩展、文件类型限制、快捷导航及跨设备配置同步。

如果您在使用 VSCode 编写代码时习惯添加 TODO、FIXME 等标记,但经常遗漏或忽略这些注释,则可能是由于默认编辑器不提供视觉强化提示。VSCode 的 TODO Highlight 插件可通过高亮显示、跳转定位和自定义关键词等方式,让待办事项始终处于视线焦点。以下是启用并优化该插件的多种配置方法:本文运行环境:MacBook Air,macOS Sequoia。

一、安装并启用基础高亮功能

该方法通过插件默认规则快速激活高亮,适用于大多数标准注释格式,无需修改配置文件即可立即生效。

1、打开 VSCode,点击左侧活动栏的扩展图标(或按快捷键 Ctrl+Shift+X)。

2、在搜索框中输入

TODO Highlight,找到作者为wayou的插件。

3、点击“安装”按钮,安装完成后点击“重新加载”使插件生效。

4、在任意打开的代码文件中插入一行注释,例如

// TODO: 优化数据库查询逻辑,确认该行文字已呈现黄色背景高亮。

二、自定义关键词匹配规则

插件默认仅识别 TODO、FIXME、XXX 等有限关键词,通过修改用户设置可扩展匹配范围,覆盖团队内部约定的标记如 NOTE、HACK、REVIEW 等。

1、按下 Cmd+,(macOS)打开设置界面,切换至“JSON”标签页(或直接使用快捷键 Cmd+Shift+P 输入 “Preferences: Open Settings (JSON)”)。

2、在 settings.

js on 文件中添加todoHighlights.keywords数组字段。

3、填入自定义关键词对象,例如:

{"pattern": "NOTE", "color": "#FFD700", "overviewRulerColor": "#FFA500"}。

4、保存文件后,所有含 NOTE 的注释将按指定颜色高亮,且侧边栏概览标尺同步显示对应色块。

三、限制高亮作用域至特定文件类型

避免在非源码文件(如 Markdown、JSON 或日志文件)中误触发高亮,可通过 languageFilter 配置限定插件仅在 .ts、.js、.py 等编程语言文件中激活。

1、在 settings.

json中定位到todoHighlights.include字段。

通义灵码 windows版通义灵码 0.8.0 是一款面向智能开发场景的轻量级集成开发环境。该版本聚焦效率与协作,提供代码智能补全、实时语法检查与版本管理功能,并优化了插件扩展能力,适配主流编程语言。0.8.0 版本进一步提升了启动速度与界面响应流畅度,内置任务运行器与调试工具,帮助开发者更快捷地完成项目构建与问题定位。简洁、现代的设计让初学者与专业团队都能快速上手。

下载2、将其值设为 glob 模式数组,例如:["**/*.ts", "**/*.js", "**/*.py"]。

3、若需排除某类文件,同时配置

todoHighlights.exclude,如["**/node_modules/**", "**/dist/**"]。

4、重启 VSCode 窗口或执行命令面板中的 “Developer: Reload Window” 以应用变更。

四、启用跳转与导航快捷键

插件内置导航能力,支持一键跳转至下一个或上一个 TODO 项,替代手动滚动查找,显著提升处理效率。

1、确保插件已启用且至少存在一条匹配注释。

2、按下快捷键

Cmd+Alt+T(macOS)或Ctrl+Alt+T(Windows/Linux),光标将跳转至下一个高亮项起始位置。

3、重复按键可在所有匹配项间循环跳转;反向跳转使用

Cmd+Alt+Shift+T。

4、在命令面板(Cmd+Shift+P)中输入

TODO: Go to Next可查看当前绑定状态及重新映射选项。

五、导出与同步高亮配置

当在多台设备间协同开发时,需统一高亮样式与关键词规则,通过导出配置片段并复用于其他环境,确保团队成员看到一致的视觉提示。

1、在 settings.json 中复制包含todoHighlights前缀的所有键值对。

2、将该配置段粘贴至 VSCode 的“用户设置”或“工作区设置”中对应位置。

3、若使用 Settings Sync 功能,确保插件配置项已勾选同步,插件本身也已登录同一 GitHub 账户。

4、在另一台设备安装 TODO Highlight 后,触发同步操作,keywords、include、defaultStyle等设置将自动还原。

相关文章