0

0

VSCode的“Better Comments”插件:让注释更醒目

P粉986688829

P粉986688829

发布时间:2025-12-25 16:27:27

|

287人浏览过

|

来源于php中文网

原创

“Better Comments”插件通过语义分级(如!警告、?疑问、TODO待办、FIXME需修复、NOTE说明)实现注释高亮,支持自定义关键词、颜色、样式及正则匹配,并可联动Todo Tree等插件提升效率。

vscode的“better comments”插件:让注释更醒目

“Better Comments”插件能让你的注释在 VSCode 里一眼就被识别出来,不是靠颜色堆砌,而是靠语义分级——不同用途的注释用不同颜色和图标,读代码时不用猜哪句是临时调试、哪句是待办、哪句是重要提醒。

支持的注释类型和默认标记

插件预设了几类常用语义标签,每种对应固定样式:

  • ! 表示警告(黄色背景+感叹号图标),比如 /* ! 这里可能有空指针风险 */
  • ? 表示疑问或待确认(蓝色),比如 /* ? 这个参数是否应该支持 null? */
  • TODO 表示待办事项(青色+复选框图标),比如 /* TODO: 后续要加单元测试 */
  • FIXME 表示需修复的问题(红色),比如 /* FIXME: 时间格式化在 iOS 上不兼容 */
  • NOTE 表示补充说明(绿色),比如 /* NOTE: 此逻辑仅适用于 v2 API */

自定义关键词和样式

你可以在设置中搜索 “better-comments.tags”,修改或新增规则。例如:

Img.Upscaler
Img.Upscaler

免费的AI图片放大工具

下载
  • 添加 {"tag": "HACK", "color": "#a29bfe", "strikethrough": true},让临时绕过方案带删除线
  • TODO 的颜色改成紫色,避免和 NOTE 混淆
  • 支持正则匹配,比如 "tag": "XXX.*" 可高亮所有以 XXX 开头的注释

配合其他插件提升效率

单独用它已经很实用,但搭配这些插件效果更明显:

  • Todo Tree:自动聚合所有 TODO/FIXME 注释,生成侧边导航树
  • Comment Anchors:给注释加锚点,快速跳转到关联代码段
  • Prettier:确保注释格式统一,避免因空格或换行破坏高亮

基本上就这些。注释不是写给机器看的,是写给人看的——让重点信息浮出来,比写得更多更重要。

相关专题

更多
c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

226

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

430

2024.03.01

堆和栈的区别
堆和栈的区别

堆和栈的区别:1、内存分配方式不同;2、大小不同;3、数据访问方式不同;4、数据的生命周期。本专题为大家提供堆和栈的区别的相关的文章、下载、课程内容,供大家免费下载体验。

359

2023.07.18

堆和栈区别
堆和栈区别

堆(Heap)和栈(Stack)是计算机中两种常见的内存分配机制。它们在内存管理的方式、分配方式以及使用场景上有很大的区别。本文将详细介绍堆和栈的特点、区别以及各自的使用场景。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

558

2023.08.10

空指针异常处理
空指针异常处理

本专题整合了空指针异常解决方法,阅读专题下面的文章了解更多详细内容。

19

2025.11.16

vscode
vscode

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

576

2023.06.30

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

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

219

2023.07.21

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

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

384

2024.03.14

笔记本电脑卡反应很慢处理方法汇总
笔记本电脑卡反应很慢处理方法汇总

本专题整合了笔记本电脑卡反应慢解决方法,阅读专题下面的文章了解更多详细内容。

1

2025.12.25

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
go语言零基础开发内容管理系统
go语言零基础开发内容管理系统

共34课时 | 2.5万人学习

第二十三期_前端开发
第二十三期_前端开发

共98课时 | 7.2万人学习

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

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