0

0

VSCode的Better Comments插件:让你的注释更有表现力

P粉986688829

P粉986688829

发布时间:2026-01-07 15:53:16

|

559人浏览过

|

来源于php中文网

原创

better comments插件可提升vscode注释语义化与可视化:安装后通过json配置自定义标签颜色,支持!(红色粗体警告)、?(蓝色斜体疑问)、todo(黄色下划线待办)等6种预设前缀,并可禁用纯文本高亮或按语言启用,还可导出配置同步多设备。

vscode的better comments插件:让你的注释更有表现力

如果您在VSCode中编写代码时希望注释更直观、更具语义区分度,Better Comments插件可通过不同颜色与符号快速标识注释类型。以下是启用并高效使用该插件的具体操作:

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

一、安装Better Comments插件

该插件需通过VSCode扩展市场获取并启用,确保其被正确加载到当前编辑器环境中。

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

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

3、点击“安装”按钮,等待状态变为“已启用”。

二、配置注释关键字与颜色

插件默认支持多种前缀注释(如!、?、TODO),但可自定义新增类型或修改对应颜色,以匹配团队规范或个人习惯。

1、按下Cmd+,打开设置界面,切换至“JSON”编辑模式(点击右上角的花括号图标)。

2、在"better-comments.tags"数组中添加新对象,例如:{"tag": "HACK", "color": "#FF00FF", "strikethrough": false, "backgroundColor": "transparent"}

3、保存文件后,所有以// HACK开头的注释将显示为品红色文本。

三、使用预设注释前缀书写语义化注释

插件内置六类高亮前缀,无需额外配置即可立即使用,每种前缀对应固定样式与视觉权重。

1、以// !开头的注释显示为红色粗体,用于标记紧急问题或严重警告。

2、以// ?开头的注释显示为蓝色斜体,适用于提出疑问或待确认事项。

TemPolor
TemPolor

AI音乐生成器,一键创作免版税音乐

下载

3、以// TODO开头的注释显示为黄色下划线,表示需要后续补充实现的功能点。

4、以// NOTE开头的注释显示为绿色常规字体,用于强调重要说明或上下文补充。

5、以// FIXME开头的注释显示为橙色加粗,专指必须修复的缺陷或错误逻辑。

6、以// IDEA开头的注释显示为青色斜体,记录临时灵感或优化建议。

四、禁用或调整全局高亮行为

当项目中存在大量旧注释或与其他插件样式冲突时,可通过关闭特定功能降低干扰,保持阅读聚焦。

1、在VSCode设置JSON中定位"better-comments.highlightPlainText"选项。

2、将其值设为false,可阻止插件对普通文本文件(如.md、.txt)中的注释进行着色。

3、若仅需在特定语言中启用,可在设置中添加"[javascript]": {"better-comments.enable": true}等语言专属配置。

五、导出与同步自定义配置

为保障多设备间注释风格一致,可将个性化标签配置保存为可复用片段,便于导入其他开发环境。

1、复制整个"better-comments.tags"数组内容,保存为better-comments-config.json文件。

2、在另一台机器的VSCode设置JSON中粘贴该数组,覆盖原有配置项。

3、重启VSCode窗口,验证新配置是否生效,例如检查// PERF是否按预期显示为紫色背景+白色文字

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

454

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

334

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

vscode
vscode

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

627

2023.06.30

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

228

2023.07.21

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

413

2024.03.14

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

393

2024.03.14

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

4

2026.03.10

热门下载

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

精品课程

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

共58课时 | 5.9万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.4万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号