Show Todo List
该插件可以帮助你在项目中查找和管理TODO注释。它会扫描你的项目文件,找出所有的TODO、FIXME等注释,并以列表形式显示在侧边栏中。点击列表项可以直接跳转到对应的文件和代码行。
功能
- 在侧边栏中显示项目中的所有TODO注释
- 支持自定义TODO注释格式(默认支持
// TODO , // FIXME , // BUG , // NOTE 格式)
- 点击列表项可以直接跳转到对应的文件和代码行
- 支持刷新列表
- 支持配置排除的文件和目录
使用方法
- 安装插件后,在活动栏中会出现一个新的图标
- 点击图标打开Todo Explorer视图
- 视图中会显示项目中的有TODO注释的文件以及文件下所有的TODO注释
- 点击列表项可以跳转到对应的文件和代码行
- 点击刷新按钮可以更新列表
配置选项
在设置中可以自定义以下选项:
showTodo.patterns : 要匹配的TODO注释模式,默认为 ["// TODO", "// FIXME", "// BUG", "// NOTE"]
showTodo.excludePatterns : 要排除的文件和目录的glob模式,默认为 ["/node_modules/", "/dist/", "/out/", "/build/", "/.git/"]
showTodo.maxFileSizeMB : 要扫描的文件大小,默认为 1MB
showTodo.maxLines : 要扫描的文件行数,默认为 10000
注释格式
在你的代码中添加如下格式的注释:
// TODO 这是一个待办事项
// FIXME 这里需要修复一个bug
// BUG 这里有一个已知问题
// NOTE 这是一个注意事项
注意:注释格式必须是以// 开头,后面跟一个空格,然后是TODO、FIXME等关键词,关键词后面再跟一个空格和具体内容。
这些注释将会被插件识别并显示在Todo Explorer视图中。
| |