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

VSCode如何使用Better Comments增强注释_VSCode Better Comments增强注释技巧

大磊酱_3306

大磊酱_3306

发布时间:2026-04-12 16:31:23

|

289人浏览过

|

来源于php中文网

原创

Better Comments 默认仅对特定前缀(如TODO、FIXME、!、?、*等)生效,且要求严格匹配大小写、格式及语言支持;// TODO未变色需检查语言ID是否支持、配置项是否拼写正确、主题是否覆盖颜色。

vscode如何使用better comments增强注释_vscode better comments增强注释技巧

Better Comments 不会自动高亮所有注释,必须用特定前缀或显式配置才生效;默认只对 TODO、FIXME、NOTE、HACK、!、?、* 这些关键词起作用,小写如 todo 或带空格的 TO DO 都不匹配。

为什么 // TODO 没变色?检查这三件事

常见现象是安装完插件,写了 // TODO: 却仍是灰色——不是插件坏了,而是环境没对齐。

  • 确认当前文件语言 ID 是否被支持:打开命令面板(Cmd+Shift+P),运行 Developer: Inspect Editor Tokens and Scopes,看右上角显示的 languageId 是不是 javascript、python 等主流语言;如果是 plaintext 或 markdown,默认不启用高亮
  • 检查 settings.json 里是否误删了 better-comments.tags 配置,或拼错成 betterComments.tags(少短横线)
  • 某些主题(尤其是自定义主题)会覆盖插件颜色,可临时切换为 VSCode 自带的 Default Dark+ 主题验证是否为样式冲突

自定义 tag 时最容易踩的坑

想加个 // REVIEW 标签却始终不着色?大概率栽在这几个细节上:

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • tag 值必须全大写、纯字母,不能含空格、冒号或连字符:"REVIEW" ✅,"review" ❌,"REVIEW:" ❌,"REVIEW-2026" ❌
  • 颜色值必须是合法十六进制格式:"#FF8C00" ✅,"ff8c00" ❌(缺 #),"rgb(255,140,0)" ❌(不支持 rgb)
  • 如果同时配置了 backgroundColor,记得设为 "transparent" 或具体色值;设成 null 或留空会导致整个配置项失效
  • 改完 settings.json 后不用重启 VSCode,但必须重新打开当前文件,或执行 Developer: Reload Window

在 Markdown 或 Shell 文件里启用高亮

默认情况下,markdown 和 shellscript 不在 Better Comments 的激活列表里,所以 README.md 里的 <!-- TODO --> 或 .sh 里的 # FIXME 不会变色。

  • 打开 settings.json,添加或修改 better-comments.highlightLanguageIds 字段,明确列出需要支持的语言:
  • "better-comments.highlightLanguageIds": ["javascript", "python", "typescript", "markdown", "shellscript"]
  • 注意:Markdown 使用的是 HTML 注释语法 <!-- TODO -->,不是 // TODO;Shell 脚本用 # FIXME,不是双斜杠
  • 若只想局部启用(比如仅对 .md 文件开启),可用语言专属设置:
  • "[markdown]": { "better-comments.enable": true }

禁用干扰项:避免误高亮旧注释或日志

项目里存在大量历史注释(如 // DEBUG: xxx)或日志语句(如 console.log("// TODO")),容易被错误识别并染色,反而降低可读性。

  • 用 better-comments.ignoreLanguageGrammars 排除高风险语言,例如禁用对 plaintext 的处理:
  • "better-comments.ignoreLanguageGrammars": ["plaintext"]
  • 若发现字符串字面量里的注释也被高亮(比如 const s = "// TODO";),说明插件未正确识别语法上下文——这是已知限制,目前无完美解法,建议避免在字符串中写带前缀的伪注释
  • 临时关闭全局高亮,只需把 better-comments.enable 设为 false;适合代码审查时快速还原“干净视图”

真正难的不是配出五颜六色的注释,而是让团队所有人写同一套前缀、删掉过期的 TODO、不在字符串里塞 // HACK。颜色只是放大器,放大的是习惯,不是魔法。

热门AI工具

更多
WorkBuddy

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

豆包大模型

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

DeepSeek

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

墨刀AI
墨刀AI Hot

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

相关专题

更多
json数据格式
json数据格式

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

1995

2023.08.07

json是什么
json是什么

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

2802

2023.08.23

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

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

956

2023.10.13

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

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

3159

2025.09.10

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

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

529

2023.09.22

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

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

1658

2024.03.01

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

1998

2023.09.20

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1598

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

热门下载

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

精品课程

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

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