在 IntelliJ IDEA 中，// region 和 // endregion 注释用于创建可折叠的代码区域，帮助你更好地组织和管理代码。这些注释不是 Java 语言的一部分，被 IntelliJ IDEA 特别识别，可以用来在代码编辑器中创建可折叠的代码块。

使用方法如下，可以创建一个可折叠的代码区域：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
public class RandomLongGenerator {

    // region Random Long Generation Methods
    
    public static long generateRandomLong() {
       return new Random().nextLong();
    }
    
    public static long generateRandomLongInRange(long min, long max) {
       return min + (long) (Math.random() * (max - min + 1));
    }
    
    // endregion

    public static void main(String[] args) {
    
    }
}

在 IntelliJ IDEA 中，当使用 // region 和 // endregion 注释创建了一个代码区域后，编辑器会在 // region 注释旁边显示一个折叠图标，如下图所示：

点击这个图标可以折叠或展开代码区域，从而隐藏或显示该区域的代码。同代码块一样，同时可以使用折叠快捷键，比如 ctrl + 加号/减号、ctrl + shift + 加号/减号 等。下面的示例中将 Jdk-21 源码的 Collections 中的方法功能分块注释使用 // region 和 //endregion 代替，效果如下：

优点：

  • 代码组织：将相关的代码块放在一起，提高代码的可读性和维护性。
  • 代码折叠：可以轻松地折叠和展开代码区域，减少代码编辑器中的视觉混乱。
  • 团队协作：团队成员可以更容易地理解代码结构，提高协作效率。

注意事项：

  • // region 和 // endregion 注释必须成对出现，否则会导致 IDE 报错或无法正确折叠代码。
  • 这些注释是 IDE 特定的，不是 Java 语言的标准部分，因此在其他 IDE 中可能不被识别。

相关链接

OB tags

#IDE #IDEA