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)

Faceswap
Faceswap

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

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

708

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

625

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

736

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

616

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1234

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

573

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

695

2023.08.11

ip地址修改教程大全
ip地址修改教程大全

本专题整合了ip地址修改教程大全,阅读下面的文章自行寻找合适的解决教程。

27

2025.12.26

热门下载

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

精品课程

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

共58课时 | 3万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 1.8万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.6万人学习

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

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