如何在VSCode中使用Better Comments插件高亮不同类型的特殊注释

冬强姑娘_4883

冬强姑娘_4883

2026-05-05

838人浏览

原创

// bug 不变色是因为未配置进 better-comments.tags 列表;需在 settings.json 中添加全大写无空格的 tag 对象,如 {"tag": "bug", "color": "#ff0000"},并确保语法正确、文件重载生效。

如何在vscode中使用better comments插件高亮不同类型的特殊注释

Better Comments 默认只高亮 TODO、FIXME、NOTE、HACK、XXX 和特殊符号(如 !、?、*),其他自定义词(比如 BUG、REVIEW、OPTIMIZE)不会变色——不是插件失效,是根本没被配置进识别列表。

为什么 // BUG 还是灰色?

插件默认不识别 BUG,哪怕你写了 // BUG: 接口未处理 401,它也按普通注释渲染。原因有三:

  • tag 值必须全大写、纯字母、无空格无符号(BUG_FIX 或 bug 都无效)
  • 配置必须写在 settings.json 的 better-comments.tags 数组里,拼错字段名(如写成 betterComments.tags 少短横线)就无效
  • 改完保存后不用重启 VSCode,但需重新打开当前文件,或执行 Developer: Reload Window 才能刷新渲染

怎么添加自定义标签(比如 REVIEW、BUG)

打开 VSCode 设置(Cmd + , 或 Ctrl + ,),搜 “better comments”,点击 “Edit in settings.json”。在 JSON 根对象内插入或修改 better-comments.tags 数组:

"better-comments.tags": [
  { "tag": "TODO", "color": "#ff8c00", "strikethrough": false },
  { "tag": "BUG", "color": "#ff0000", "strikethrough": true },
  { "tag": "REVIEW", "color": "#9C27B0", "strikethrough": false }
]

注意:

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • 每个 tag 必须紧贴 // 后无空格,即 // BUG: 有效,// BUG: 失效
  • 小写 todo 或带下划线的 opt_improve 不匹配
  • 如果用了 Prettier 或 ESLint,保存时可能自动加空格,导致前缀失效;可临时禁用格式化验证

为什么 .md 或 .sh 文件里的 // TODO 不高亮?

Better Comments 默认不启用对 plaintext、markdown、shellscript 等语言的支持。现象是:在 .js 里 // TODO 变黄,在 .md 里仍是灰色。

  • 确认当前文件语言 ID:按 Cmd+Shift+P → Developer: Inspect Editor Tokens and Scopes,看右上角显示的 languageId
  • 若想对 Markdown 启用,需显式配置:"better-comments.highlightLanguageIds": ["javascript", "python", "markdown"]
  • 更保守的做法是禁用干扰项:"better-comments.ignoreLanguageGrammars": ["plaintext"],避免误匹配纯文本文件

颜色被主题覆盖了怎么办?

某些自定义主题(尤其第三方暗色主题)会覆盖插件设定的颜色,导致 // FIXME 看起来和普通注释一样。

  • 临时切换为 VSCode 自带的 Default Dark+ 主题,验证是否为样式冲突
  • 检查 settings.json 中是否有其他插件或主题相关配置干扰了 editor.tokenColorCustomizations
  • 特殊符号(!、?)的颜色由 better-comments.highlightSpecialCharacters 控制,默认开启;关掉就全失效
容易被忽略的是:所有配置都存在用户本地 settings.json 或工作区 .vscode/settings.json 里,而后者常被忽略或未提交——团队协作时,务必把 better-comments.tags 写进项目级配置,并确保 .vscode/ 目录已纳入版本管理。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3189

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2328

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1260

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1218

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1356

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2178

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3500

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

15955

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程