vscode 灵活使用TODO Highlight插件
前言
随着日常代码的产出,有些时候我们希望代码的注释能够区分一下优先级和类型,比如我发现了一个问题,但是这个问题可能需要以后有时间再修复,又或许为了实现某个功能,我使用了hack的方式,我希望能够给后来者一个提醒,方便接手人的维护,基于这些需求,我找到了一个插件:TODO Highlight
它可以很方便的实现注释上的高亮处理,因为我暂时还不需要去大量查询todo,所以就没安装TODO Tree这个插件。
实现看下效果图:
由于官方默认只预设了TODO:
和FIXME:
,其他是我自己拓展的,大家可以按照下面的教程配置一下。
自定义扩展TODO
vscode -> 文件 -> 首选项 -> 设置 -> 右上角打开设置json -> 进入到json配置文件页面,填入以下内容:
// todohighlight
"todohighlight.keywords": [
"DEBUG:",
"REVIEW:",
{
"text": "NOTE:",
"color": "#fff",
"backgroundColor": "#67C23A",
"overviewRulerColor": "grey"
},
{
"text": "BUG:",
"color": "#fff",
"backgroundColor": "#F56C6C",
"overviewRulerColor": "grey"
},
{
"text": "INFO:",
"color": "#fff",
"backgroundColor": "#909399",
"overviewRulerColor": "grey"
},
{
"text": "HACK:",
"color": "#fff",
"backgroundColor": "#E040FB",
"overviewRulerColor": "grey"
}
]
然后就行了。
todo标签对应的意思
//TODO:
:这里需要完成一些工作,但目前还未完成。通常用于提示开发人员有某项任务需要完成。//FIXME:
:这里有一个已知的问题或错误需要修复。通常用于标记代码中的 bug 或问题,等待被修复。//NOTE:
:这是一个值得注意的事项,用于标记需要特别注意的地方,或者对某个问题的额外解释。//BUG:
:这是一个已知的错误或问题。这个标签和//FIXME:
类似,都是用来标记代码中的 bug。//INFO:
:这是对代码的一些额外信息或解释。这可以为阅读和理解代码提供帮助。//HACK:
:这是一种权宜之计或临时解决方案。通常在代码中使用这个标识来表明,这部分代码并不理想,有待优化。
版权申明
本文系作者 @木灵鱼儿 原创发布在木灵鱼儿站点。未经许可,禁止转载。
暂无评论数据