使用 TodoReview 插件可高效管理项目中的 TODO 任务:1. 通过 Package Control 安装插件;2. 配置 keywords、file_patterns 和 folder_exclude_patterns 自定义扫描规则;3. 使用 “TodoReview: Show” 命令查看并跳转任务列表;4. 结合团队注释规范与开发流程,提升代码维护效率。

在 Sublime Text 中高效管理项目中的 TODO 任务,可以借助 TodoReview 插件实现集中查看和快速跳转。它能自动扫描代码中的注释标记(如 TODO、FIXME),生成可交互的任务列表,提升开发效率。
安装 TodoReview 插件
使用 Package Control 安装插件是最便捷的方式:
- 按下 Ctrl+Shift+P(Mac 上为 Cmd+Shift+P)打开命令面板
- 输入 “Install Package”,选择对应选项
- 搜索 “TodoReview”,点击安装
安装完成后无需重启,即可使用相关命令。
配置扫描关键字和文件范围
TodoReview 默认识别 TODO 和 FIXME,你可以在设置中自定义关键词和搜索路径:
- 进入菜单 Preferences → Package Settings → TodoReview → Settings
- 修改 "keywords" 列表,例如添加 "NOTE", "BUG" 等
- 通过 "file_patterns" 指定要扫描的文件类型(如 *.py, *.js)
- 设置 "folder_exclude_patterns" 避免扫描 node_modules 等目录
示例配置片段:
{
"keywords": ["TODO", "FIXME", "BUG", "NOTE"],
"file_patterns": ["*.py", "*.js", "*.html", "*.css"],
"folder_exclude_patterns": [".git", "node_modules", "__pycache__"]
}
使用 TodoReview 查看和跳转任务
配置完成后,调用插件查看所有待办项:
- 按下 Ctrl+Shift+P 打开命令面板
- 输入 “TodoReview: Show” 并执行
- 侧边栏将列出所有匹配的 TODO 条目,包含文件名、行号和内容
- 点击任意条目,直接跳转到代码对应位置进行处理
支持按项目根目录或当前文件所在目录运行扫描,适合多项目协作场景。
结合项目工作流提升效率
在日常开发中,建议统一团队的注释规范,例如:
- TODO: 待完成功能
- FIXME: 已知问题需修复
- NOTE: 重要说明
配合 Git 提交前使用 TodoReview 快速检查遗留任务,避免遗漏。也可将其集成进构建流程或代码审查环节,形成闭环管理。
基本上就这些。用好 TodoReview,能让散落在代码中的待办事项变得清晰可控,特别适合中小型项目或个人开发者提升专注力。不复杂但容易忽略。










