IntelliJ IDEA三种注释方法

一、行注释

快捷键Ctrl+/（或者直接//+注释内容）

以下面几行简单代码为例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import java.util.Scanner;

public class Plus {
    public static void main(String[] args) {
        Scanner scanner = new Scanner(System.in);
        int n = scanner.nextInt();//输入一个n
//把n传入到plus方法中，然后输出
        System.out.println(plus(n));
    }

    public static int plus(int n) {
        int sum = 0;
        for (int i = 1; i <= n; i++) {
            sum = sum + i;
        }
        return sum;
    }
}

二、块注释Ctrl+Shift+/

快捷键Ctrl+Shift+/（或者直接/**/然后在中间添加内容）

以下面几行简单代码为例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import java.util.Scanner;

public class Plus {
    public static void main(String[] args) {
        Scanner scanner = new Scanner(System.in);
        int n = scanner.nextInt();
        System.out.println(plus(n));
    }

    public static int plus(int n) {
        int sum = 0;
        /*
         * 定义一个for循环:
         * 从1一直加到n
         * 把值传给sum
         * */
        for (int i = 1; i <= n; i++) {
            sum = sum + i;
        }
        return sum;
    }
}

三、方法或类注释

无快捷键，输入/**+Enter，然后就会自动根据参数和返回值生成注释模板，我们在这个模板上面编写即可。

以下面几行简单代码为例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
import java.util.Scanner;

public class Plus {
    public static void main(String[] args) {
        Scanner scanner = new Scanner(System.in);
        int n = scanner.nextInt();
        System.out.println(plus(n));
    }

    /**
     * 定义一个方法：
     * 传入一个参数n
     * 返回一个从1加到n的数sum
     *
     * @param n
     * @return sum
     */
    public static int plus(int n) {
        int sum = 0;
        for (int i = 1; i <= n; i++) {
            sum = sum + i;
        }
        return sum;
    }
}

四、综合

结合上面的三种注释就可以得到一个十分通俗易懂的代码了，当然在简单的代码中没必要写的这么详细。但是在实际项目中往往是上千行，甚至有的大项目上万行代码，这里注释就显得十分重要了，合理运用注释，可以让代码十分通俗易懂。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
import java.util.Scanner;

public class Plus {
    public static void main(String[] args) {
        Scanner scanner = new Scanner(System.in);
        int n = scanner.nextInt();//输入一个n
//把n传入到plus方法中，然后输出
        System.out.println(plus(n));
    }

    /**
     * 定义一个方法：
     * 传入一个参数n
     * 返回一个从1加到n的数sum
     *
     * @param n
     * @return sum
     */
    public static int plus(int n) {
        int sum = 0;
        /*
         * 定义一个for循环:
         * 从1一直加到n
         * 把值传给sum
         * */
        for (int i = 1; i <= n; i++) {
            sum = sum + i;
        }
        return sum;
    }
}