如何通过VSCode安装BetterComments插件,用彩色注释高效区分任务优先级?
- 内容介绍
- 文章标签
- 相关推荐
本文共计880个文字,预计阅读时间需要4分钟。
提示:
为什么 // TODO 还是灰色——检查这三件事
安装完 Better Comments,写了 // TODO 却没高亮,常见原因就三个:
- 当前文件右下角显示的 languageId 是
plaintext或markdown,而这两个默认不在插件激活列表里;用命令面板运行Developer: Inspect Editor Tokens and Scopes,光标停在注释上,看顶部显示的languageId是什么 -
settings.json里拼错了字段名:必须是better-comments.tags(带短横线),写成betterComments.tags或better_comments.tags都无效 - 注释格式不对:
// TODO:中的:不影响匹配,但// todo(小写)、// TO DO(带空格)、// TODO(末尾多空格)全都不触发高亮
自定义 BUG、REVIEW 标签怎么配才生效
想让 // BUG 变红、// REVIEW 变紫,得手动加进 better-comments.tags 数组,但容易栽在细节上:
-
tag值必须全大写、纯字母、无空格无符号:"BUG"✅,"bug"❌,"BUG-2026"❌,"BUG:"❌ - 颜色值必须是合法十六进制:
"#FF2D00"✅,"ff2d00"❌(缺#),"rgb(255,45,0)"❌(不支持 rgb) - 如果加了
backgroundColor,不能留空或设为null,得明确写"transparent"或具体色值,否则整条配置失效 - 改完
settings.json后不用重启 VSCode,但必须重载窗口(Cmd+Shift+P→Developer: Reload Window)或重新打开该文件
在 .md、.sh 文件里启用高亮
Markdown 和 Shell 脚本默认不被 Better Comments 支持,因为它们的注释语法不同:
- Markdown 用的是 HTML 注释:
<!-- TODO -->,不是// TODO;Shell 用# FIXME,不是双斜杠 - 要在
settings.json里显式开启:"better-comments.highlightLanguageIds": ["javascript", "python", "typescript", "markdown", "shellscript"] - 同时注意:对
markdown生效的是<!-- TODO -->,对shellscript生效的是# FIXME,混用会失效 - 更稳妥的做法是用语言专属设置:
"[markdown]": { "better-comments.enable": true }
别让 Prettier 或 ESLint 搞崩高亮效果
自动格式化工具常在保存时偷偷加空格,比如把 //! 改成 // !,导致特殊符号前缀失效:
-
//!、//?、//*这些符号必须紧贴//,中间**不能有空格** - 检查 Prettier 的
prettier.trailingComma或 ESLint 的spaced-comment规则,禁用对注释前导空格的强制修正 - 如果团队统一用 Prettier,建议在
.prettierrc加上:"comments": false(部分版本支持),或直接关掉注释相关规则
真正卡住人的地方往往不是“怎么加标签”,而是 languageId 判断逻辑、大小写与空格的零容忍、以及格式化工具和插件之间的静默冲突——这些细节不翻文档根本想不到。
本文共计880个文字,预计阅读时间需要4分钟。
提示:
为什么 // TODO 还是灰色——检查这三件事
安装完 Better Comments,写了 // TODO 却没高亮,常见原因就三个:
- 当前文件右下角显示的 languageId 是
plaintext或markdown,而这两个默认不在插件激活列表里;用命令面板运行Developer: Inspect Editor Tokens and Scopes,光标停在注释上,看顶部显示的languageId是什么 -
settings.json里拼错了字段名:必须是better-comments.tags(带短横线),写成betterComments.tags或better_comments.tags都无效 - 注释格式不对:
// TODO:中的:不影响匹配,但// todo(小写)、// TO DO(带空格)、// TODO(末尾多空格)全都不触发高亮
自定义 BUG、REVIEW 标签怎么配才生效
想让 // BUG 变红、// REVIEW 变紫,得手动加进 better-comments.tags 数组,但容易栽在细节上:
-
tag值必须全大写、纯字母、无空格无符号:"BUG"✅,"bug"❌,"BUG-2026"❌,"BUG:"❌ - 颜色值必须是合法十六进制:
"#FF2D00"✅,"ff2d00"❌(缺#),"rgb(255,45,0)"❌(不支持 rgb) - 如果加了
backgroundColor,不能留空或设为null,得明确写"transparent"或具体色值,否则整条配置失效 - 改完
settings.json后不用重启 VSCode,但必须重载窗口(Cmd+Shift+P→Developer: Reload Window)或重新打开该文件
在 .md、.sh 文件里启用高亮
Markdown 和 Shell 脚本默认不被 Better Comments 支持,因为它们的注释语法不同:
- Markdown 用的是 HTML 注释:
<!-- TODO -->,不是// TODO;Shell 用# FIXME,不是双斜杠 - 要在
settings.json里显式开启:"better-comments.highlightLanguageIds": ["javascript", "python", "typescript", "markdown", "shellscript"] - 同时注意:对
markdown生效的是<!-- TODO -->,对shellscript生效的是# FIXME,混用会失效 - 更稳妥的做法是用语言专属设置:
"[markdown]": { "better-comments.enable": true }
别让 Prettier 或 ESLint 搞崩高亮效果
自动格式化工具常在保存时偷偷加空格,比如把 //! 改成 // !,导致特殊符号前缀失效:
-
//!、//?、//*这些符号必须紧贴//,中间**不能有空格** - 检查 Prettier 的
prettier.trailingComma或 ESLint 的spaced-comment规则,禁用对注释前导空格的强制修正 - 如果团队统一用 Prettier,建议在
.prettierrc加上:"comments": false(部分版本支持),或直接关掉注释相关规则
真正卡住人的地方往往不是“怎么加标签”,而是 languageId 判断逻辑、大小写与空格的零容忍、以及格式化工具和插件之间的静默冲突——这些细节不翻文档根本想不到。

