VSCode代码注释高亮_使用Better Comments区分注释类型

轻墨大大_2591

轻墨大大_2591

2026-04-16

238人浏览

原创

better comments 默认仅高亮 todo、fixme、note 等预设标签,自定义标签如 bug 或 review 需手动添加至 settings.json 的 better-comments.tags 数组中,且 tag 值必须全大写、纯字母、无空格符号,否则不生效。

vscode代码注释高亮_使用better comments区分注释类型

默认安装后只识别 TODO、FIXME、NOTE 等几个固定标签,你写的 BUG 或 REVIEW 不会变色——不是插件失效,是根本没被配置进识别列表。

安装后为什么部分注释不生效

Better Comments 默认只对 // TODO、// FIXME、// NOTE、// HACK、// XXX 和特殊符号前缀(如 // !、// ?)做高亮。其他任意自定义词(比如 // BUG、// OPTIMIZE)必须手动加到 better-comments.tags 配置里,否则一律按普通灰色注释渲染。

常见错误现象:

  • // BUG: 接口返回空数组未处理 保持灰色,毫无提示
  • 改写成 // ! BUG 也不行——! 是独立前缀,不能和 BUG 混用
  • 在 settings.json 里写了小写 "tag": "todo",结果不生效(必须大写无空格)

如何正确添加自定义注释标签

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

"better-comments.tags": [
  {
    "tag": "BUG",
    "color": "#ff0000",
    "strikethrough": true,
    "backgroundColor": "transparent"
  },
  {
    "tag": "REVIEW",
    "color": "#FF8C00",
    "strikethrough": false,
    "backgroundColor": "transparent"
  }
]

关键点:

  • 每个 tag 值必须全大写、纯字母、无空格无符号(BUG_FIX 或 bug 都无效)
  • // ! 和 // ? 这类符号前缀是独立规则,不走 tags 数组,不要试图把 "tag": "!" 写进去
  • 改完保存后,**不用重启 VSCode**,但需重新打开当前文件或重载窗口(Cmd+Shift+P → Developer: Reload Window)才能刷新渲染

为什么 Markdown 或 Shell 文件里注释没颜色

Better Comments 默认只在主流编程语言(如 javascript、python、typescript)中启用。像 markdown、shellscript、plaintext 这些语言 ID 不在默认白名单里,所以 // TODO 在 .md 里就是普通文本。

解决方法是在 settings.json 中显式开启支持:

VSCode
VSCode

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

下载
"better-comments.languageSupport": ["javascript", "python", "typescript", "markdown", "shellscript"]

或者更保守地禁用干扰项:

"better-comments.ignoreLanguageGrammars": ["plaintext"]

注意:highlightPlainText 设为 false 可全局关闭对纯文本文件的着色,避免在日志或配置片段里误触发。

团队协作时注释样式不一致怎么办

个人设置写在用户级 settings.json 里,别人看不到。要统一效果,必须把 better-comments.tags 和 better-comments.languageSupport 配置下沉到项目根目录下的 .vscode/settings.json。

这样新成员克隆仓库后,只要打开文件夹,VSCode 就自动读取并应用团队约定的注释规范。

容易忽略的细节:

  • .vscode/settings.json 里的配置优先级高于用户设置,但不会覆盖所有用户设置项,只影响明确声明的部分
  • 如果团队用了 eslint 或 prettier,记得确认它们不禁止 // REVIEW 这类自定义注释格式(一般不会,但某些严格规则可能报 warning)
  • 别把 backgroundColor 设成不透明色(比如 "#000000"),否则深色主题下文字会看不见

颜色再丰富,也救不了没意义的注释。真正起作用的是谁写、什么时候写、写完有没有人跟进——插件只是把“该看的”推到眼前,剩下的得靠流程兜住。

相关文章

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

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

下载

相关标签:

vscode

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

相关专题

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

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

2023.06.20

3169

3

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

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

2023.07.25

2308

9

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

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

2023.08.02

1240

5

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

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

2023.08.09

1198

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

2158

7

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

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

2023.09.20

3460

8

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

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

2023.09.22

15755

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

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