0

0

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

P粉986688829

P粉986688829

发布时间:2025-12-27 17:10:23

|

585人浏览过

|

来源于php中文网

原创

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)

阿里云AI平台
阿里云AI平台

阿里云AI平台

下载

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 或更高数值以提升可读性。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

49

2026.02.13

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

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

196

2026.02.25

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

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

37

2026.03.13

json数据格式
json数据格式

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

82

2025.09.10

vscode
vscode

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

628

2023.06.30

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

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

26

2026.03.13

热门下载

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

精品课程

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

共58课时 | 6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.4万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

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

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