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

JavaDoc是一種將注釋生成HTML文檔的技術，生成的HTML文檔類似於Java的API，易讀且清晰明了。在簡略介紹JavaDoc寫法之后，再看一下在Intellij Idea 中如何將代碼中的注釋生成HTML文檔。

先看一段樣例代碼：

//: object/Documentation  
/** 這是一個Javadoc測試程序 
 *  @author Mike
 *  @version 1.0 
 *  @since 1.5 
 * */  
public class Documentation {  
    /**這是一個成員變量 
     * */  
    public String name;  
    /** a function 
     * @param name 姓名 
     * @return 返回name姓名 
     * @throws  Exception 無異常拋出 
     * */  
    public String function(String name) throws Exception{  
        return name;  
    }  
}///:~  

稍微解釋一下：

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

@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