0

0

VSCode的Better Comments插件:让你的注释更具可读性

P粉986688829

P粉986688829

发布时间:2026-01-11 19:49:03

|

675人浏览过

|

来源于php中文网

原创

VSCode中可通过安装Better Comments插件并配置语义化注释标记(如TODO、FIXME等)及自定义颜色、多语言支持和禁用选项,显著提升注释可读性与团队协作效率。

如果您在vscode中编写代码时发现注释难以区分类型、缺乏视觉层次,导致团队协作或后期维护效率降低,则可能是由于注释风格单一、语义不明确所致。以下是提升注释可读性的具体操作方式:

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

一、安装Better Comments插件

Better Comments通过语法着色将不同语义的注释(如提醒、待办、高亮、疑问等)映射为对应颜色,使开发者能快速识别注释意图,无需逐字阅读。

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

2、在扩展搜索框中输入Better Comments

3、在搜索结果中找到作者为aaron-bond的插件,点击“安装”按钮。

4、安装完成后,点击“重新加载”以启用插件功能。

二、使用预设注释标记语法

插件默认识别特定前缀符号组合,自动应用对应颜色与语义样式,无需额外配置即可生效。

1、在代码中输入// TODO:后跟文字,该行注释将显示为黄色背景。

2、输入// FIXME:后跟文字,该行注释将显示为红色高亮。

3、输入// HACK:后跟文字,该行注释将显示为橙色斜体。

4、输入// NOTE:后跟文字,该行注释将显示为蓝色粗体。

5、输入// REVIEW:后跟文字,该行注释将显示为紫色下划线。

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

可通过修改VSCode设置文件,添加项目专属注释标识,适配团队内部约定或特定开发规范。

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

2、点击右上角的“打开设置(JSON)”图标,进入settings.json文件。

社研通
社研通

文科研究生的学术加速器

下载

3、在json对象内添加键值对:"better-comments.tags",其值为包含多个对象的数组。

4、每个对象需包含"tag"(字符串)、"color"(十六进制颜色码)、"strikethrough"(布尔值)和"backgroundColor"(可选)字段。

5、例如添加自定义标记:{"tag": "XXX", "color": "#ff2d75", "strikethrough": true},保存后即可识别// XXX:开头的注释。

四、启用多语言支持配置

Better Comments默认支持主流语言,但部分语言需显式声明注释语法结构,确保颜色规则正确触发。

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

2、若当前项目使用TypeScript React,需确认该语言ID已列入支持列表,如未包含则手动添加"typescriptreact"

3、对Vue SFC文件,需确保"vue"在语言支持数组中,并检查单文件组件内的

4、重启VSCode或重新打开相关文件,验证注释着色是否在目标语言中正常生效。

五、禁用特定注释类型的高亮

当团队规范禁止某类标记(如禁用HACK),或某类颜色干扰阅读时,可选择性关闭其样式渲染,保持注释区简洁。

1、打开settings.json文件。

2、查找"better-comments.tags"数组。

3、定位到对应标签对象,将其"color"字段值修改为"inherit"

4、将"strikethrough"设为false,并移除"backgroundColor"字段(如有)。

5、保存文件,该类注释将恢复为普通文本样式,但仍保留在代码中供检索。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

552

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

374

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

730

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

475

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

394

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

656

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

551

2023.09.20

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

80

2026.01.09

热门下载

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

精品课程

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

共42课时 | 6.3万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 1.4万人学习

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

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