vscode 自定义 todoTree配置 TODO FIXME BUG TAG FEATURE 等配置

zeuskk

已于 2024-07-17 16:07:55 修改

阅读量201

点赞数 1

分类专栏：解决日常bug 大前端文章标签： vscode

于 2022-07-21 11:33:54 首次发布

本文链接：https://blog.csdn.net/god953/article/details/125908268

版权

大前端同时被 2 个专栏收录

48 篇文章 1 订阅

订阅专栏

解决日常bug

7 篇文章 0 订阅

订阅专栏

VSCode 主题设置推荐，自定义配色方案，修改注释高亮颜色
- https://blog.csdn.net/sinat_39620217/article/details/115618730
VScode最全面最实用的插件推荐，用了你就爱上了！
- https://blog.csdn.net/sinat_39620217/article/details/115618757
  1.Vscode Todo Tree插件安装
  在vscode扩展中心，搜索 todo tree 然后安装，
  Todo Tree插件会有自带的icon图标样式，如下图：

2.TODO、FIXME和XXX的注释使用说明
TODO: + 说明：
如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。

FIXME: + 说明：
如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。

XXX: + 说明：
如果代码中有该标识，说明标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明。

3.在VScode中打造自己专属的图标调试：
3.1打开vscode中的settings.json文件：
英文界面换中文界面链接：https://blog.csdn.net/sinat_39620217/article/details/115614986

方法一：点击左下角设置按钮

在搜索框输入：settings.json,并选中

方法二：点击左下角设置按钮点击设置

然后出现如下界面，点击文本编辑器，慢慢往下滑动找到settings.json，点击即可。

方法三：点击左下角设置按钮点击设置

进入和方法二一样的界面，点击右上角的json文件也可以进入settings.json

3.2 设置自己的todo tree注释样式
我自己的样式图标仅供参考：

在settings.json配置代码：【注意：根据json文件格式要求，每段结束后记得加逗号，逗号！！！ },】

//todo-tree settings
    "todo-tree.regex.regex": "((//|#|<!--|;|/\\*|^)\\s*($TAGS):|^\\s*- \\[ \\])",
    "todo-tree.general.tags": [
        "TODO",
        "FIXME",
        "tag",
        "done",
        "bug",
        "feature"
    ],
    "todo-tree.regex.regexCaseSensitive": false,
    "todo-tree.tree.showInExplorer": true,
    "todo-tree.highlights.defaultHighlight": {
        "foreground": "white",
        "background": "Orange",
        "icon": "checklist",
        "rulerColour": "Orange",
        "type": "tag",
        "iconColour": "Orange"
    },
    "todo-tree.highlights.customHighlight": {
    
        "FIXME": {
            "background": "red",
            "icon": "beaker",
            "rulerColour": "red",
            "iconColour": "red",
            "opacity": 50,
        },
        "tag": {
            "background": "Magenta",
            "icon": "pin",
            "rulerColour": "Magenta",
            "iconColour": "Magenta",
            "rulerLane": "full",
            "opacity": 50,
        },
        "done": {
            "background": "DarkTurquoise",
            "icon": "verified",
            "rulerColour": "DarkTurquoise",
            "iconColour": "DarkTurquoise",
            "opacity": 50,
        },
        "bug": {
            "background": "green",
            "icon": "bug",
            "rulerColour": "green",
            "iconColour": "green",
            "opacity": 50,
        },
        "feature": {
            "background": "LightSkyBlue",
            "icon": "milestone",
            "rulerColour": "LightSkyBlue",
            "iconColour": "DeepSkyBlue",
            "opacity": 50,
        },
    },

自用版本-前面添加自己喜欢的前缀

"todo-tree.regex.regex": "((//|#|<!--|;|/\\*|^)\\s*($TAGS):|^\\s*- \\[ \\])",
  "todo-tree.general.tags": ["ZKTODO", "ZKFIXME", "ZKTAG", "ZKDONE", "ZKBUG", "ZKFEATURE"],
  "todo-tree.regex.regexCaseSensitive": false,
  "todo-tree.tree.showInExplorer": true,
  "todo-tree.highlights.defaultHighlight": {
    "foreground": "white",
    "background": "Orange",
    "icon": "checklist",
    "rulerColour": "Orange",
    "type": "tag",
    "iconColour": "Orange"
  },
  "todo-tree.highlights.customHighlight": {
    "ZKFIXME": {
      "background": "red",
      "icon": "beaker",
      "rulerColour": "red",
      "iconColour": "red",
      "opacity": 50
    },
    "ZKTAG": {
      "background": "Magenta",
      "icon": "pin",
      "rulerColour": "Magenta",
      "iconColour": "Magenta",
      "rulerLane": "full",
      "opacity": 50
    },
    "ZKDONE": {
      "background": "DarkTurquoise",
      "icon": "verified",
      "rulerColour": "DarkTurquoise",
      "iconColour": "DarkTurquoise",
      "opacity": 50
    },
    "ZKBUG": {
      "background": "green",
      "icon": "bug",
      "rulerColour": "green",
      "iconColour": "green",
      "opacity": 50
    },
    "ZKFEATURE": {
      "background": "LightSkyBlue",
      "icon": "milestone",
      "rulerColour": "LightSkyBlue",
      "iconColour": "DeepSkyBlue",
      "opacity": 50
    }
  }