如何设置VSCode中Better Comments插件，使不同注释类型自动变色显示？

本文共计788个文字，预计阅读时间需要4分钟。

默认安装后即可高亮以下几种代码块：

怎么加自定义注释标签（比如 BUG、REVIEW）

插件只认大写、纯字母、无空格无符号的 tag 字符串，小写或带下划线都不行。

• BUG ✅ 有效；bug ❌ 不触发；BUG_FIX ❌ 不触发
• 打开 settings.json（Cmd+, → 右上角“打开设置(JSON)”），添加或修改 better-comments.tags 数组
• 每个对象必须包含 tag、color，可选 strikethrough 和 backgroundColor
• 示例：

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

• 保存后不用重启 VSCode，但要重载窗口（Cmd+Shift+P → Developer: Reload Window）或重新打开文件才刷新渲染

为什么 //! 或 //? 没变色

这类单字符前缀走的是独立规则，不进 tags 数组，也不受大小写影响，但对格式极其敏感。

• 必须紧贴双斜杠后、**零空格**：//! ✅，// ? ❌，// ! ❌
• 颜色由 better-comments.highlightSpecialCharacters 控制，默认开启；关掉就完全失效
• 如果用了 Prettier/ESLint，保存时可能自动插入空格，导致符号“消失”——建议在 Prettier 配置中禁用 insertSpaceAfterOpeningAndBeforeClosingNonemptyParentheses 类似规则，或改用 ESLint 的 spaced-comment 规则约束注释格式
• 别把 "tag": "!" 写进 tags 数组里，它不处理这个

为什么 .md、.sh 或 .vue 模板里注释没颜色

Better Comments 默认只在 javascript、typescript、python、go 等语言 ID 白名单中启用，不靠后缀判断，而看右下角显示的语言模式。

• markdown、shellscript、plaintext 默认被排除；.vue 文件中只有 <script> 块继承 JS/TS 模式能高亮，<template> 块不支持
• 要在 Markdown 中启用，需在 settings.json 添加：

  "better-comments.languageSupport": ["markdown", "shellscript"]

• 若只想在某些语言启用（比如只开 JS），可用语言专属配置：

  "[javascript]": { "better-comments.enable": true }

• 注意：加了 languageSupport 后，// TODO 在 .md 里会高亮，但 <!-- TODO --> 或 # TODO 仍无效——插件只识别当前语言模式下的合法单行注释语法

最常被忽略的一点：改完 settings.json 后，VSCode 不会实时更新已打开文件的注释渲染，必须重载窗口或关闭再打开文件；另外，团队共用配置时，应把 better-comments.tags 和 better-comments.languageSupport 写进项目根目录的 .vscode/settings.json，而不是用户级设置，否则协作时效果不一致。