我的团队通常会在未完成的代码部分中使用TODO这个词。有没有一种方法可以将用户指定的关键字添加到Visual Studio中,以便以某种方式突出显示它们呢?例如,在vim中,TODO这个词会自动突出显示。
例如,我想看到像这样的东西:
//这是一个桩 -
TODO:
移动到另一个项目
我的团队通常会在未完成的代码部分中使用TODO这个词。有没有一种方法可以将用户指定的关键字添加到Visual Studio中,以便以某种方式突出显示它们呢?例如,在vim中,TODO这个词会自动突出显示。
例如,我想看到像这样的东西:
//这是一个桩 -
TODO:
移动到另一个项目
像其他人说的那样,你需要为VS安装插件(至少在VS2015中需要)来突出显示文本。对于那些使用Resharper的人:
从菜单中选择ReSharper -> Options -> Tools -> To-Do-Items。
添加你的新评论和模式。你可以通过编辑现有的评论来复制它。我为我的新评论使用了与Todo
相同的设置:
Title: AnythingYouWant
Regular Expression: `(?<=\W|^)(?<TAG>AnythingYouWant)(\W|$)(.*)`
Put a check "In comments"
Color: Web->Blue
Icon: Normal
在你的代码中像这样使用:
// AnythingYouWant 这个注释会被突出显示为蓝色
在Visual Studio中:
转到工具 > 选项 > 环境 > 任务列表
在那里,您可以添加任何用户指定的单词,每次构建并查看任务列表时,它都会以与 //TODO: 相同的方式显示在您的任务列表中。
周围有很多这样的插件,但我发现最好、最简单的一个是wayou.vscode-todo-highlight。然而,看起来这个扩展的维护已经被放弃了。
设置简单明了易于使用,但不幸的是,开箱即用的示例设置(和文档)很糟糕,所以为了让生活更简单,只需将其复制/粘贴到您的(用户)设置JSON文件中即可。
在Win-10上,用户设置位于此处:
C:\Users\<username>\AppData\Roaming\Code\User\settings.json
。
//------------------------------------------
// wayou.vscode-todo-highlight
//------------------------------------------
// For colors, see:
// https://dev59.com/lWIj5IYBdhLWcg3wMiUu
"todohighlight.isEnable": true,
"todohighlight.isCaseSensitive": true,
"todohighlight.keywords": [
"ToDo",
"DEBUG:",
"REVIEW:",
{
"text": "NOTE:", //
"color": "yellow", //
"backgroundColor": "#006400", // DarkGreen #FF006400 (argb)
"overviewRulerColor": "grey", //
"fontWeight": "bold", //
},
{
"text": "HACK:", //
"color": "#000", //
"isWholeLine": false, //
"fontWeight": "bold", //
//"margin": "5px", // [padding, border, margin] Not working!
},
{
"text": "TODO:", //
"color": "red", //
//"border": "1px solid red", //
"borderRadius": "1px", //NOTE: using borderRadius along with `border` or you will see nothing change
"backgroundColor": "rgba(4,4,4,.2)", // "rgba(0,0,0,.2)"
"isCaseSensitive": false, //
// Add other styling properties here.
}
],
//"todohighlight.keywordsPattern": "TODO:|FIXME:|\\(([^)]+)\\)", //highlight `TODO:`,`FIXME:` or content between parentheses
"todohighlight.defaultStyle": {
"color": "red", //
"backgroundColor": "#ffab00", //
"overviewRulerColor": "#ffab00", //
"cursor": "pointer", //
"border": "1px solid #666", //
"borderRadius": "2px", //
"isWholeLine": false, //
// Add other default styling properties here.
},
"todohighlight.include": [
"**/*.js",
"**/*.jsx",
"**/*.ts",
"**/*.tsx",
"**/*.html",
"**/*.php",
"**/*.css",
"**/*.scss",
"**/*.ps1"
],
"todohighlight.exclude": [
"**/node_modules/**",
"**/bower_components/**",
"**/dist/**",
"**/build/**",
"**/.vscode/**",
"**/.github/**",
"**/_output/**",
"**/*.min.*",
"**/*.map",
"**/.next/**"
],
"todohighlight.maxFilesForSearch": 5120,
"todohighlight.toggleURI": false
//------------------------------------------
注意:我没有包含外部的{}
。
正如其他人所回答的那样,对于使用ReSharper的人来说,他们的标签应该会自动高亮显示,但是设置标签的选项所在的位置称为“待办事项浏览器”。不确定自从其他答案以来是否有所改变,但想要补充一下,适用于2023年之后使用ReSharper的任何人。