实际可用的是 jetbrains 官方推荐的 show comments 插件,需在 settings > tools > show comments 中启用并配置自定义标签、scope 和十六进制颜色;正则匹配须以 @ 开头、转义空格冒号、捕获组命名合法且修改后点击 reload;高亮失效优先检查注释语法、文件类型支持及颜色方案设置。

插件名不是 Awesome Comments,而是 Show Comments
官方插件市场里没有叫 Awesome Comments 的插件——你搜不到、装不上、也找不到配置入口。实际可用的是 JetBrains 官方推荐的 Show Comments(由 JetBrains 自研,非第三方),它默认已随 IDEA 捆绑安装,无需额外下载。很多用户卡在第一步,就是因为搜错了名字。
怎么启用并配置自定义注释标签?
直接打开 Settings > Tools > Show Comments,别去 Marketplace 找“Awesome”前缀的插件。关键操作如下:
- 勾选
Enable custom tags开关 - 点击
+ Add tag添加你团队约定的标签,比如@review、@security、@tech-debt - 每个标签必须指定
scope:选CLASS(类级)、METHOD(方法级)或LINE(行级),否则高亮不生效 - 颜色值用十六进制,如
#FF5722,别写red或rgb(255,87,34),后者会被忽略
正则匹配注释内容时常见失败原因
Show Comments 支持正则提取注释中的结构化信息(如负责人、截止日期),但以下写法极易出错:
- 正则开头漏写
@:例如想匹配@review: alice,正则必须是@review\s*:\s*(?<owner>\w+)</owner>,不能省略@ - 未转义空格或冒号:
@review : alice中的空格和冒号需用\s*和:显式表达,写成@review:alice会漏掉带空格的合法注释 - 捕获组命名含非法字符:只能用字母、数字、下划线,
owner-name会报错,得写成owner_name或owner - 测试时没刷新:改完正则后要手动点一下右上角的
Reload按钮,否则编辑器不会重扫描
为什么注释没高亮?优先检查这三处
即使配置完成,仍可能看不到效果,问题通常不在插件本身:
-
File > Settings > Editor > Color Scheme > General > Code > Comments里,确认Line comment和Block comment的字体颜色没被设为背景色(比如白色底+白色字) - 注释写法不符合 Java/JS/Python 等语言规范:例如在 Python 里写
// @review是无效的,得用# @review或"""@review""" - 当前文件类型未被插件支持:默认只处理
.java、.js、.py等主流后缀,.ts或.kt需手动在Show Comments > File types中添加
Scope 和 file type 这两个参数一旦配错,注释就彻底“隐身”,比颜色设置更难排查。











