JavaDoc是一種將註釋生成HTML文件的技術，生成的HTML文件類似於Java的API，易讀且清晰明瞭。在簡略介紹JavaDoc寫法之後，再看一下在Intellij Idea 中如何將程式碼中的註釋生成HTML文件。

先看一段樣例程式碼：

 1 //: object/Documentation  
 2 /** 這是一個Javadoc測試程式 
 3  *  @author Mike
 4  *  @version 1.0 
 5  *  @since 1.5 
 6  * */  
 7 public class Documentation {  
 8     /**這是一個成員變數 
 9      * 
 
*/  
10     public String name;  
11     /** a function 
12      * @param name 姓名 
13      * @return 返回name姓名 
14      * @throws  Exception 無異常丟擲 
15      * */  
16     public String function(String name) throws Exception{  
17         return name;  
18     }  
19 }///:~  

稍微解釋一下：

以//: 開始，以///:~結束。

@author  作者名

@version 版本號

@since 指明需要最早使用的jdk版本

@param 引數名

@return 返回值情況

@throws 異常丟擲情況

idea生成HTML文件的方法：

第一步：

第二步：

1. 選擇是整個專案還是模組還是單個檔案

2. 文件輸出路徑

3. Locale 選擇地區，這個決定了文件的語言，中文就是zh_CN

4. 傳入JavaDoc的引數，一般這樣寫： -encoding UTF-8 -charset UTF-8 -windowtitle "文件HTML頁面標籤的標題" -link http://docs.Oracle.com/javase/7/docs/api

 （紅色字型全是都是要填的，“文件HTML頁面標籤的標題”是指文件的標籤的標題，可以自己改）