## 注釋（Comments） 在這一節，我們會講一下注釋（Comments），單行注釋（Single Line Comments）和多行注釋（Multi Line Comments）還有JavaDoc風格的注釋。 所以回到IntelliJ 注釋不是可執行的代碼，它們可以放在任意地方，注釋可以讓你的代碼更容易讀懂。但是如果有過多的注釋，代碼也會可讀性很差，且難以理解。在考試當中你不會看到很多的注釋， 基本上出考題的人會盡量讓代碼更加難以理解，更加難讀懂。 在這一節，你會看到很多問題，類型可能會出現在考試中的。在這個課程中，你經常會看到代碼有注釋，寫注釋總是一個好習慣。以便你在幾周或幾個月后再看自己的代碼時，更容易看懂當初寫的是什么。 ### 單行注釋（Single Line Comments） 所以讓我們先看一下單行注釋 單行注釋由兩個正斜杠（Slash）開始 //， 然后是注釋的內容。例如 ```java package io.zwt; public class Main { public static void main(String[] args) { // printing size of arguments System.out.println("args-size= " + args.length); for (int i = 0; i < args.length; i++) { System.out.println("args[" + i + "]=" + args[i]); } } } ``` 上面的就是單行注釋，你甚至可以有空的注釋 ```java // // ``` 你也可以注釋掉代碼，英文說法是 comment out ```java package io.zwt; public class Main { public static void main(String[] args) { // printing size of arguments // // //System.out.println("args-size= " + args.length); for (int i = 0; i < args.length; i++) { System.out.println("args[" + i + "]=" + args[i]); } } } ``` 被注釋掉的代碼，不會再執行。在IntelliJ 可以使用快捷鍵 `Ctrl+/`注釋掉某行。例如我可以選項某行，或者多個行，然后按下 `Ctrl+/`，這樣子就會注釋掉所選的行。如果是多行注釋就是 `Ctrl+Shift+/`。 ### 多行注釋（Multi Line Comments） 多行注釋由正斜杠和星號開始，即 `/*` 所以如果我現在輸入 `/*` 下邊的代碼就不再編譯了，提示由編譯錯誤了。Unclose comment。 所以為了關閉這個多行注釋塊，我們需要輸入 `*/`。 這樣就形成了多行注釋，或者是塊注釋（Block Comments），所以就是有一對的，開閉的。 `/* */` 例如下面代碼就是注釋掉了 for 循環。 ```java package io.zwt; public class Main { public static void main(String[] args) { // printing size of arguments // // //System.out.println("args-size= " + args.length); /* for (int i = 0; i < args.length; i++) { System.out.println("args[" + i + "]=" + args[i]); } */ } } ``` 接下來我們恢復for循環，在它上面寫多行注釋： ```java package io.zwt; public class Main { public static void main(String[] args) { // printing size of arguments // // //System.out.println("args-size= " + args.length); /* * printing arguments * another line. */ for (int i = 0; i < args.length; i++) { System.out.println("args[" + i + "]=" + args[i]); } } } ``` ### JavaDoc風格注釋 還有一種注釋就是JavaDoc風格的注釋，也就是文檔注釋，它們可以被JavaDoc文檔工具處理。如果你使用JavaDoc工具生成文檔，這些注釋里的內容就會出現在文檔上。 在IntelliJ 里面創建的JavaDoc風格的注釋，是輸入 `/**` 然后按`Enter`這樣就會是JavaDoc風格的注釋。因為它開頭是 `/**`兩個星號，然后換行。 JavaDoc風格的注釋通常出現在類或者是方法頭上。它其實也可以在變量上，但是不用擔心這個，后面遇到了會講的。所以然我們在Main類里邊再添加一個JavaDoc注釋。 在main方法的頭上，輸入`/**`按下Enter，發現IntelliJ自動生成了JavaDoc注釋，并且添加了 `@param args`。所以這就是方法的參數。如果我們的方法有多個參數，它會添加所有的參數的。然后我們可以為這些參數添加注釋了。還可以給方法本身添加注釋，例如： ```java package io.zwt; public class Main { /** * This is main method. * @param args command line arguments */ public static void main(String[] args) { // printing size of arguments // // //System.out.println("args-size= " + args.length); /* * printing arguments * another line. */ for (int i = 0; i < args.length; i++) { System.out.println("args[" + i + "]=" + args[i]); } } } ``` 如果方法有返回值，創建JavaDoc注釋時，IntelliJ還會自動添加返回值類型`@return`，例如下面： ```java package io.zwt; public class Main { /** * This is main method. * @param args command line arguments */ public static void main(String[] args) { // printing size of arguments // // //System.out.println("args-size= " + args.length); /* * printing arguments * another line. */ for (int i = 0; i < args.length; i++) { System.out.println("args[" + i + "]=" + args[i]); } } /** * * @param a * @param b * @return */ public static int sum(int a, int b) { return a + b; } } ``` 上面的 sum 方法只是一個簡單的方法，只是為了演示JavaDoc注釋。在這個方法上面用IntelliJ 創建JavaDoc，可以看到： ``` /** * * @param a * @param b * @return */ ``` 兩個參數的注釋，還有返回值的注釋，所以我們可以說： ```java /** * 計算兩個整數的和 * @param a 操作數 * @param b 操作數 * @return 求和 */ public static int sum(int a, int b) { return a + b; } ``` 所以如果我們在main方法里邊調用這個 sum方法，可以看到IntelliJ提示它需要兩個參數，而且如果我們用 `Ctrl+Q`查看一下快速文檔，我們也可以看到注釋所寫的內容。這就是JavaDoc注釋的作用。 所以就算是在自己的代碼，寫JavaDoc注釋也很有幫助，有助于了解各個部分，各個方法的作用。