vsCode安装todo插件

这篇博客介绍了如何在编辑器中利用小树图标查看和高亮显示代码中的TODO注释,帮助开发者更便捷地跟踪和管理待办任务。通过点击小树,可以一键查看所有待办事项,提升代码维护效率。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

 

安装之后,我们编辑器会出现一个小树:

 

点击小树,就可以查看我们代码里面所有的TODO;

另外在代码里面我们的“TODO”会高亮显示:

### 如何在 VSCode安装和设置 Todo Tree 插件 #### 安装插件 要开始使用 Todo Tree 插件,首先需要将其安装到 Visual Studio Code (VSCode) 中。可以通过以下方法实现: 1. 打开 VSCode 并进入左侧活动栏中的扩展视图(快捷键 `Ctrl+Shift+X` 或点击左侧面板上的“扩展”图标)。 2. 在搜索框中输入 **Todo Tree**,找到由 Gruntfuggly 开发的同名插件并单击“安装”按钮[^3]。 #### 配置插件 安装完成后,可以按照以下方式对 Todo Tree 进行个性化配置: ##### 修改默认关键字 Todo Tree 支持自定义关键词列表,默认情况下会识别常见的标记如 `TODO`, `FIXME`, 和 `XXX` 等。如果希望增加或更改这些标签,可以在用户设置文件 (`settings.json`) 中调整如下参数: ```json { "todo-tree.regex.regex": "(//|/\\*|\\*)\\s*(TODO|FIXME|HACK|NOTE):", "todo-tree.highlights.customHighlight": { "BUG": "#ff0000", // 自定义颜色用于标注 BUG 关键字 "REVIEW": "#ffff00" } } ``` 上述 JSON 片段展示了如何通过正则表达式指定新的匹配模式以及为特定的关键字分配独特的显示样式[^5]。 ##### 设置忽略路径 为了防止不必要的干扰,可以从扫描范围里排除某些目录或者文件类型。这通常适用于第三方库所在的节点模块或是编译产物所在的位置。同样是在全局设定里面添加类似下面的内容: ```json "todo-tree.general.ignoreGlobs": [ "**/node_modules/**", "*.log" ] ``` ##### 显示面板位置 还可以决定树形结构展示在哪一侧——左边还是右边。此选项位于同样的地方: ```json "todo-tree.panel.position": "right" ``` #### 使用指南 一旦完成了前面提到的所有准备工作之后,就可以正常使用该功能了。每当创建一个新的待办事项时,只需要遵循之前所定义好的格式书写相应的注解即可自动同步至右侧的任务清单当中去查看。 另外值得注意的是,虽然 Todo Highlight 和 Todo Tree 功能相似,但是两者之间存在差异;前者更专注于语法层面高亮表现而后者提供了一个独立窗口集中呈现所有发现项。 ```python # Example of using a custom keyword with Todo Tree def some_function(): pass # REVIEW: This function needs further testing before release. ```
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值