1. 程式人生 > 其它 >JavaDoc文件生成

JavaDoc文件生成

JavaDoc文件生成方法

package jie.jie.JavaDoc;

/**
 * @author jie    //作者名
 * @version 1.0   //版本號
 * @since 1.8     //指明引數需要最早使用的版本
 */
public class Doc {
    String name;

    /**
     *
     * @param name        //引數名
     * @return            //返回值情況
     * @throws Exception  //異常丟擲情況
     */
    public String test(String name) throws Exception{
        return name;
    }
}

1.命令列輸出方法

進入對應資料夾目錄後按住shift進入dos命令列執行以下程式碼
javadoc -encoding UTF-8 -charset UTF-8 Doc.java

2.IDEA自帶生成JavaDoc方法

選擇你生成檔案的具體位置

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


生成完畢