【IDEA神器】Show Comment 插件配置指南：如何优雅地屏蔽公共类注释？

1. 背景

在日常开发中，IntelliJ IDEA 的 Show Comment 插件是一个阅读源码和业务代码的神器，它能直接在代码行尾和项目文件树中显示 Javadoc 注释，大大降低了代码理解成本。

但随之而来的问题是：信息过载。 并不是所有类的注释我们都需要看到。例如项目中的 common 包、工具类（Utils）、或者底层的 BaseEntity，它们的注释往往千篇一律（如“创建时间”、“修改人”），长期显示在屏幕上只会造成视觉干扰，掩盖了真正核心业务逻辑的注释。

本文将分享如何通过配置正则表达式（Regex），精准屏蔽特定包或类的注释，还你一个清爽的开发视界。

2. 核心需求

我们希望达到以下效果：

• 保留： 核心业务包（如 Service, Controller, 复杂 Domain）的中文业务注释。
• 屏蔽： JDK 原生类（如 String, List）的注释。
• 屏蔽： 项目公共模块（如 src/main/java/com/saiit/ncis/base/common）下的所有通用代码注释。

3. 配置步骤

第一步：进入全局设置

打开 IDEA 设置，路径如下： Settings -> Tools -> // Show Comment App -> // Show Comment Global

注意：必须进入 Global 菜单，只有这里才支持强大的正则过滤功能。

第二步：配置排除规则 (Exclude Regex)

找到配置项：className#memberName exclude Regexp: （默认值通常为 ^(java)\.，表示屏蔽 JDK 自带类）。

我们需要利用正则表达式的“或”运算符 |，将想要屏蔽的包路径追加到后面。

配置公式：

^(java)\.|^你的\.包名\.路径\.

实战案例： 假设你想屏蔽 com.saiit.ncis.base.common 包下的所有类，请将该输入框的内容修改为：

^(java)\.|^com\.saiit\.ncis\.base\.common\.

规则解析：

• ^(java)\.：保留默认设置，屏蔽 JDK 原生类。
• |：逻辑“或”，表示满足任一条件即屏蔽。
• ^：匹配字符串开头。
• \.：因为 . 在正则中是特殊字符，所以需要用 \ 转义，表示匹配真实的点号。

第三步：应用生效

点击右下角的 Apply 和 OK。此时再回到编辑器，你会发现 common 包下的代码行尾已经变得干干净净，而核心业务代码的注释依然保留。

---

4. 进阶：打造最佳视觉体验 (Best Practices)

除了屏蔽特定包，建议配合以下通用设置（位于 // Show Comment App 主界面），让体验更上一层楼：

1. 开启 skip English (跳过英文)

   • 建议： ✅ 勾选
   • 理由： 大多数第三方框架（Spring, MyBatis）的源码注释是英文的，勾选后可自动隐藏，只保留我们自己写的中文注释。

2. 开启 skip @ (跳过注解)

   • 建议： ✅ 勾选
   • 理由： 防止插件把 @Override, @Autowired 等代码注解误判为文本注释显示出来。

3. 调整颜色 (Text Color)

   • 建议： 设置为 浅灰色 (如 #808080 或 #A9B7C6)
   • 理由： 默认的绿色太抢眼。注释应该是“按需索取”的辅助信息，灰色能降低存在感，让你专注于代码逻辑本身。

4. 开启 get --> set

   • 建议： ✅ 勾选
   • 理由： 自动简化 Getter/Setter 的冗余注释，避免看到满屏的“获取XXX”、“设置XXX”。

5. 总结

工具是为了服务开发者的。通过简单的正则配置，我们可以让 Show Comment 插件变得更“聪明”，只在对的地方显示对的信息。

配置一键复制：

^(java)\.|^com\.saiit\.ncis\.base\.common\.