剑指vscode - Todo Tree（代办事项树）

最新推荐文章于 2024-10-02 13:59:53 发布

趁你病要你命

最新推荐文章于 2024-10-02 13:59:53 发布

阅读量1.1k

点赞数 23

文章标签： vscode ide 编辑器

本文链接：https://blog.csdn.net/fashion_lie/article/details/136061979

版权

本文介绍了TodoTreeVisualStudioCode扩展，它能将代码中的TODO、FIXME等标记以树视图形式展示，提高查找效率。作者分享了安装方法、个性化配置以及常见标记含义。

摘要由CSDN通过智能技术生成

插件地址：Todo Tree - Visual Studio MarketplaceExtension for Visual Studio Code - Show TODO, FIXME, etc. comment tags in a tree viewhttps://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree

我们写代码的时候，经常会写一些todo，但经常都是用编辑器的搜索功能去搜索，那么有什么插件可以帮助我们快速找到这些todo呢，所以这里推荐一款todo插件

话不多说，先看效果

是不是就很方便看了

安装

安装完了，在vscode左侧菜单中，会出现跟插件图标同样的图标

注意：配置写在用户信息的settings.json（除非你不想全局生效）

以下是截图

我自己的配置

{
    "todo-tree.regex.regexCaseSensitive": true, // 使用区分大小写的正则表达式
    "todo-tree.general.tags": ["TODO", "FIXME", "BUG", "INFO", "HACK", "XXX", "NOTE", "TAG", "UPDATE"],
    //如果相应变量没赋值就会使用这里的默认值
    "todo-tree.highlights.defaultHighlight": {
        "foreground": "#000000", // 字体颜色
        "background": "#ffff00", // 背景色
        "icon": "alert", // 标签样式 alert 是一个"感叹号"的样式，图标可参考文章最后
        "rulerColour": "#ffff00", // 边框颜色
        "type": "line", // 填充色类型  可在TODO TREE 细节页面找到允许的值
        "iconColour": "#ffff00" // 标签颜色
    },
    // 覆盖对应的TODO变量
    "todo-tree.highlights.customHighlight": {
        // 代办事项或者需要做的功能
        "TODO": {},
        // 必须要修复的BUG
        "BUG": {
            "background": "#ff0000",
            "icon": "bug",
            "rulerColour": "#ff0000",
            "iconColour": "#ff0000"
        },
        // 标签
        "TAG": {
            "background": "#38b2f4",
            "icon": "tag",
            "rulerColour": "#38b2f4",
            "iconColour": "#38b2f4",
            "rulerLane": "full"
        },
        // 需要更新或者优化升级点
        "UPDATE": {
            "background": "#d65d8e",
            "icon": "unverified",
            "rulerColour": "#d65d8e",
            "iconColour": "#d65d8e"
        }
    },
}

常用标记

一般来，标记都有对应的意思

TODO：待办标记，用来标记待办的地方。表示标记处有功能代码待编写，待实现的功能在说明中会简略说明。
HACK：待修改标记，用来标记可能需要更改的地方。在写代码的时候，有的地方我们并不确定他是正确的，可能未来有所更改，这时候可以使用HACK标记。
FIXME：待修复标记，用来标记一些需要修复的位置。表示标记处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。
XXX：改进标记，用来标记一些草率实现的地方。在写代码的时候，有些地方需要频繁修改，代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明。
NOTE：说明标记，添加一些说明文字。
INFO：信息标记，用来表达一些信息。
TAG：标识标记，用来创建一些标记。

当然了，这些你高兴，或者团队有规范

如果你不需要那么多标记，也可以删除 todo-tree.general.tags 中的标记就行