為什麼要寫註釋？（個人看法）

• 記錄一下程式碼實現的思路，方便日後檢視
• 幫助團隊協作開發
• 使別人瞭解程式碼的結構和功能
• 可以瞭解到程式碼什麼時候更新了，更新了什麼
• 程式碼是誰負責的

Java的註釋一共分為三種，分別是單行註釋、多行註釋、文件註釋。

單行註釋

單行註釋使用//標註。

// 計算兩個整數的和
public static int sum(int a, int b) {
     return a + b;
}

多行註釋

多行註釋使用/* */標註。
多行註釋不能巢狀使用。

  /*
   這是一個函式
   用來計算兩個整數的和
   */
   public static int sum(int a, int b) {
       return a + b;
   }
 

文件註釋

文件註釋可以註釋多行內容，通常用來生成文件。
使用/** */來標註。

/**
* @author hllog
* @since 1.8
* @param a
* @param b
* @return The sum of two numbers
*/
public static int sum(int a, int b) {
	return a + b;
}

命令列生成

javadoc -encoding UTF-8 -charset UTF_* Demo.java

idea生成

1. Tools
2. Generate JavaDoc
3. 進行引數配置
4. 點選OK即可生成文件