VSCode的Better Comments插件:让你的注释拥有不同颜色和含义

14次阅读

Better Comments 插件可实现 TODO、FIXME、NOTE 等注释语义高亮:安装后默认启用颜色区分,支持自定义关键词与颜色、按语言禁用、深浅色主题适配。

VSCode的Better Comments插件:让你的注释拥有不同颜色和含义

如果您在使用 vscode 编写代码时希望注释具备语义区分能力,使 TODO、FIXME、NOTE 等标记自动呈现不同颜色与视觉权重,则 Better Comments 插件可直接实现该效果。以下是启用并配置该插件的具体操作路径:

本文运行环境:macBook Pro,macOS Sequoia。

一、安装 Better Comments 插件

该插件需通过 VSCode 的扩展市场获取并安装,安装后默认启用基础语义着色规则,无需额外配置即可识别常见注释前缀。

1、打开 VSCode,点击左侧活动栏的扩展图标(四个方块组成的图标)。

2、在扩展搜索框中输入 Better Comments,找到作者为 aaron-bond 的插件。

3、点击“安装”按钮,等待状态变为“已安装”后,重启 VSCode 以确保插件完全加载。

二、启用默认语义高亮规则

Better Comments 内置预设关键词组,如 TODO、FIXME、NOTE、HACK、XXX 等,安装后自动绑定对应颜色,无需手动编辑设置文件即可生效。

1、新建或打开任意支持注释语法的文件(如 .js、.py、.ts)。

2、在代码中输入 // TODO: 修复登录超时逻辑,观察其是否显示为黄色高亮。

3、输入 // FIXME: 数组越界未校验,确认其是否显示为红色高亮。

三、自定义注释关键字与颜色

用户可通过修改 VSCode 设置中的 better-comments.tags 配置项,添加专属标识符并指定其颜色、样式及是否加粗,从而扩展语义覆盖范围。

1、按下 Cmd + ,(macOS)打开设置界面,切换至“文本编辑器” > “Better Comments” 面板。

2、点击右上角“打开 settings.json”链接,在 jsON 文件中定位到 “better-comments.tags” 数组字段。

3、在数组内插入新对象,例如:{“tag”: “REVIEW”, “color”: “#FF8C00”, “strikethrough”: false, “backgroundColor”: “transparent”}

4、保存文件后,在代码中使用 // REVIEW: 请检查此算法复杂度 即可看到橙色高亮效果。

四、禁用特定语言的注释高亮

某些语言(如 markdown 或 Shell 脚本)可能因注释格式特殊导致误匹配,此时可针对语言 ID 排除 Better Comments 的作用范围,避免干扰原始渲染效果。

1、在 settings.json 中新增 “better-comments.ignoreLanguageGrammars” 字段。

2、将其值设为包含语言 ID 的字符串数组,例如:[“markdown“, “shellscript”]

3、保存配置后,重新打开 .md 或 .sh 文件,验证注释是否恢复为默认单色显示。

五、切换深色/浅色主题下的颜色适配

Better Comments 默认采用固定 RGB 值定义颜色,但在 VSCode 主题切换时可能出现对比度不足问题,此时需手动调整颜色值以保障可读性。

1、进入 VSCode 设置界面,搜索 better-comments.customColors

2、启用该选项后,在 settings.json 中添加 “better-comments.customColors” 对象。

3、为每种 tag 分别定义 “dark”“light” 子属性,例如:“TODO”: {“dark”: “#FFD700”, “light”: “#FF8C00”}

text=ZqhQzanResources