VSCode的Better Comments:让注释更具表现力

6次阅读

Better Comments 扩展通过颜色、图标和字体样式提升注释可读性:需安装启用,默认支持!/?/* 标记,可自定义 TODO/HACK 等标签颜色,限制语言范围防误匹配,并调整字体粗细与大小。

VSCode 的 Better Comments:让注释更具表现力

如果您在使用 VSCode 编写代码时发现注释难以区分优先级、类型或意图,则可能是由于缺乏语义化标记机制。Better Comments 扩展通过为不同用途的注释赋予颜色和图标,显著提升注释的可读性与表达力。以下是实现该效果的具体方式:

本文运行环境:MacBook Air,macOS Sequoia。

一、安装 Better Comments 扩展

该扩展需通过 VSCode 的扩展市场获取并启用,是所有后续功能生效的前提。

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

2、在搜索框中输入 Better Comments,确认作者为 aaron-bond

3、点击“安装”按钮,安装完成后点击“重新加载”使扩展生效。

二、启用默认注释样式

Better Comments 内置了预设的关键词规则,启用后无需额外配置即可识别常见注释前缀。

1、按下 Cmd + , 打开设置界面。

2、在搜索框中输入 better-comments.tags,确保该项已启用。

3、重启 VSCode 或重新打开一个代码文件,观察以 !?* 开头的注释是否呈现对应颜色。

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

用户可根据团队规范或个人习惯,添加专属标记词并指定其显示样式。

1、按下 Cmd + Shift + P 打开命令面板。

2、输入并选择 Preferences: Open Settings (JSON)

3、在 settings.json 中插入以下代码段:

“better-comments.tags”: [{“tag”: “TODO”, “color”: “#FF8C00”, “strikethrough”: false}, {“tag”: “HACK”, “color”: “#CC0000”, “strikethrough”: true} ]

4、保存文件,刷新当前编辑器窗口,验证新标签是否按设定渲染。

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

某些语言(如 Markdown 或 Shell 脚本)可能因语法特性导致误匹配,可通过语言范围限制避免干扰。

1、在 settings.json 中定位到 better-comments.highlightLanguageIds 配置项。

2、将其值修改为仅包含需要启用的语言 ID,例如:[“javascript“, “python“, “typescript“]

3、删除或注释掉 markdown“shellscript” 等不必要项。

五、调整注释字体样式与大小

注释文本的视觉权重可通过字体粗细与字号微调,以适配不同显示器或阅读偏好。

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

2、将值设为 “bold italic” 以增强强调效果。

3、搜索 better-comments.fontSize,设置为 13 或更高数值以提升可读性。

星耀云
版权声明:本站原创文章,由 星耀云 2025-12-27发表,共计1234字。
转载说明:转载本网站任何内容,请按照转载方式正确书写本站原文地址。本站提供的一切软件、教程和内容信息仅限用于学习和研究目的;不得将上述内容用于商业或者非法用途,否则,一切后果请用户自负。本站信息来自网络,版权争议与本站无关。
text=ZqhQzanResources