經常使用工具說明-- Intellij Idea生成JavaDoc

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