讲师中心 微信公众号
AI工具推荐 视频效率加速

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

老枫姑娘_3169

老枫姑娘_3169

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

|

755人浏览过

|

来源于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文件。

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载

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"在语言支持数组中,并检查单文件组件内的<script>区块是否被正确识别为JavaScript上下文。</script>

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

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

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

1、打开settings.json文件。

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

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

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

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

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

232

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

460

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

311

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

226

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

458

2026.06.16

json数据格式
json数据格式

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

1955

2023.08.07

json是什么
json是什么

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

2642

2023.08.23

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

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

916

2023.10.13

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

20

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
uni-app快速上手
uni-app快速上手

共0课时 | 0人学习

Vue 教程
Vue 教程

共42课时 | 16.7万人学习

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

共26课时 | 2.4万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn