别再让 TODO 烂在代码里!这款 VS Code 插件帮你一键管理所有待办注释
你有没有过这样的经历:写代码时随手敲下一句
// TODO: 这里以后要优化,然后……就再也没有然后了。
项目越写越大,散落在各个文件里的 TODO、FIXME、HACK 注释越来越多,等到真想收拾它们的时候,却根本不记得当初写在哪了。今天给大家安利一款专门解决这个痛点的轻量级 VS Code 插件 —— Todo Genie(待办精灵)。
🤔 它能解决什么问题?
一句话:把你代码里所有的待办注释,自动收集到侧边栏一个清单里,点一下就能跳转到对应代码。
不用再靠全局搜索一个个找 TODO,不用担心写过的待办被遗忘。打开侧边栏,所有待办一目了然。
✨ 核心特性
1. 全代码库扫描,一个都不漏
插件会自动扫描整个工作区的所有文本文件,把 TODO、FIXME、HACK、BUG、XXX、NOTE 等标记统统揪出来。
而且足够聪明:
- 自动跳过
node_modules、.git、dist、build等依赖和构建目录 - 自动忽略二进制文件和超大文件
- 只识别注释里的标记(支持
//、/* */、#、<!-- -->、--、;等多种语言的注释风格),不会把字符串或文档里的 “todo list” 误判进来
2. 两种分组方式,随心切换
点击视图标题栏的分组按钮,可以在两种视图间一键切换:
- 按标记分组 —— 所有
TODO归一类,所有FIXME归一类,适合按类型集中处理 - 按文件分组 —— 按文件查看每个文件里有哪些待办,适合逐个文件清理
3. 点击即跳转
清单里的每一条都能点击,直接定位到对应文件的对应行,告别手动翻找。
4. 实时更新,无需手动刷新
你在编辑、新建或删除文件时,插件会自动重新扫描(带防抖处理,不卡顿),清单始终保持最新。
5. 标记可自定义
默认的标记不够用?在设置里配置成你团队约定的任意关键词,比如 REVIEW、OPTIMIZE、WTF 都行。
🚀 三步上手
- 在 VS Code 扩展商店搜索 Todo Genie 并安装
- 点击活动栏(最左侧)的 Todo Genie 图标打开视图
- 点击清单里任意一项,即可跳转到对应代码
安装后会自动扫描整个工作区,之后随着你的编辑实时更新,真正做到「装上就忘,需要时它都在」。
⚙️ 配置项一览
| 配置项 | 说明 |
|---|---|
todo-genie.tags |
要扫描的注释标记,默认 TODO、FIXME、HACK、BUG、XXX、NOTE |
todo-genie.groupBy |
分组方式:按标记 tag 或按文件 file |
todo-genie.exclude |
额外排除的 glob 规则,例如 **/*.min.js |
🎮 可用命令
- Todo Genie: Refresh —— 手动重新扫描工作区
- Todo Genie: Toggle Grouping(Tag / File) —— 切换分组方式
💡 适合谁用?
- 喜欢用注释记待办、但总是忘记回头处理的开发者
- 接手老项目,想快速摸清里面埋了多少坑(
FIXME/HACK)的人 - 团队协作中,需要统一管理待办标记的小组
📦 写在最后
Todo Genie 主打一个轻量、无打扰:没有复杂配置,没有臃肿界面,装上就能用,把散落各处的待办收拢成一份清晰的清单。
如果它帮你少踩了一个坑,或者让你少忘了一个 TODO,欢迎到 GitHub 仓库 点个 ⭐ Star,也欢迎提 Issue 反馈建议。
开源地址:https://github.com/joygqz/todo-genie
License:MIT
让每一条 TODO 都不再被遗忘 —— 这就是 Todo Genie。✅
AtomGit 是由开放原子开源基金会联合 CSDN 等生态伙伴共同推出的新一代开源与人工智能协作平台。平台坚持“开放、中立、公益”的理念,把代码托管、模型共享、数据集托管、智能体开发体验和算力服务整合在一起,为开发者提供从开发、训练到部署的一站式体验。
更多推荐
所有评论(0)