VSCode快速添加TODO标记_利用插件管理项目开发进度

VSCode快速添加TODO标记：利用插件管理项目开发进度

结论先行：如果你在VSCode里需要一个管理TODO标记的插件，直接安装Todo Tree就够了。它扫描速度快、不拖累大型项目、支持点击跳转、默认就能识别常见的TODO/FIXME/NOTE标签，而且自定义新标签也最省心。相比之下，TODO Highlight或Todo+要么功能局限，要么配置繁琐。

为什么Todo Tree比其他插件更可靠

你可能会问，VSCode自带的全局搜索（Ctrl+Shift+F）不也能找到TODO吗？确实可以，但它有几个硬伤：搜索结果不会常驻在侧边栏，无法按文件分类折叠，也没有醒目的图标，更不支持一键跳转。这用来临时查一下还行，但作为日常进度管理工具，效率就太低了。

再来看看其他插件。TODO Highlight的主要功能是行内高亮，如果想在侧边栏看到列表，还得额外执行TODO: List命令。更麻烦的是它的配置，todo.highlight.keywords这个字段格式很挑剔，一不小心把对象写成数组，整个高亮功能就直接失效了。至于Todo+，功能确实强大，但配置项相当分散（比如todo.tags、todo.archiveOnComplete等），对于中小型项目来说，反而有点“杀鸡用牛刀”的复杂感。

而Todo Tree的优势在于“开箱即用”。安装后基本无需调整设置，它默认就启用实时扫描，文件一保存，侧边栏的列表立刻刷新。右键列表中的任何条目，就能快速定位到文件或标记为完成。其树状结构更是天然优势，即便有上百个TODO散落在几十个文件里，也能通过折叠一目了然地看清分布，管理起来非常直观。

装完就用：三步确认插件真生效

插件装好了，先别急着去配置JSON文件。花一分钟完成下面三个步骤，验证基础功能是否正常运行：

• 首先，打开一个包含// TODO: 加个防抖这类注释的.ts文件，看看该行代码是否出现了浅蓝色的背景高亮。
• 接着，按下Ctrl+Shift+P，输入Todo Tree: Toggle Tree并执行，确认侧边栏弹出了树形列表，并且你刚写的TODO项已经归类在对应的文件节点下了。
• 最后，双击侧边栏里的那条TODO，检查编辑器是否会自动跳转到代码的对应行并聚焦光标。

如果以上任何一步没成功，那问题可能出在插件没有正确加载，或者当前的文件类型被意外排除在外了。例如，你正在编辑.vue文件，但todo-tree.languages配置里却没有包含"vue"。

加自定义标签（如REVIEW / BUG）的正确写法

很多人想在settings.json里通过修改todo-tree.customHighlight来添加像REVIEW、BUG这样的自定义标签，但常常遇到新标签不显示图标或者颜色不对的问题。这背后的根本原因，往往是字段名写错了，或者数据结构嵌套不正确。

正确的格式应该是这样的：

{
  "todo-tree.customHighlight": {
    "REVIEW": {
      "icon": "eye",
      "color": "#FFA500",
      "foreground": "#000000"
    },
    "BUG": {
      "icon": "bug",
      "color": "#FF3B30",
      "foreground": "#FFFFFF"
    }
  }
}

这里有几个关键点需要注意：customHighlight的值必须是一个对象（用花括号{}包裹），而不是数组；每个标签的key是纯字符串（不要包含//或空格）；icon字段必须使用VSCode支持的codicon图标名称（例如eye、bug、zap等）。

配置保存后，立刻在代码里写一句// REVIEW: 参数校验逻辑待确认试试，效果应该立竿见影。

大项目必配的性能保护项

在超过十万行代码的大型项目中，Todo Tree默认会扫描整个工作区，这包括node_modules、dist这类通常无需关注的目录。结果就是首次加载可能卡顿3到5秒，后续每次文件保存的响应也会变慢。

为了避免这种情况，必须配置以下两项进行排除和限定：

• 将todo-tree.excludeGlobs设置为["**/node_modules/**", "**/dist/**", "**/build/**", "**/.git/**"]，排除构建产物和依赖目录。
• 显式设定todo-tree.includeGlobs，例如["**/*.ts", "**/*.js", "**/*.py", "**/*.go"]，根据项目实际使用的语言来限定扫描范围。

千万别相信“插件默认只扫描源码”这种说法。它的默认行为就是扫描所有文件，除非你明确告诉它哪些不需要扫。漏掉excludeGlobs这一项，项目一打开，CPU占用率可能瞬间就飙升了。

话说回来，使用TODO插件真正麻烦的，其实不是技术配置，而是团队协作的规范。一个团队里，有人用// TODO:，有人写/* FIXME */，还有人把待办项塞进Markdown里当检查清单。Todo Tree虽然能通过统一的正则和路径规则来收集这些标记，但前提是所有人都遵守同一套书写规范。这件事没法靠插件自动解决，更可靠的做法是：将统一的Todo Tree配置写入.vscode/settings.json并提交到代码仓库，同时在Pull Request的模板里加上一句——“请检查本次修改中的TODO标记是否符合团队规范”。