JavaDoc

1.介紹

JavaDoc是一種將註釋生成HTML文件的技術，生成的HTML文件類似於Java的API，易讀且清晰明瞭。

JavaDoc是Sun公司提供的一個技術，它從程式原始碼中抽取類、方法、成員等註釋形成一個和原始碼配套的API幫助文件。也就是說，只要在編寫程式時以一套特定的標籤作註釋，在程式編寫完成後，通過JavaDoc就可以同時形成程式的開發文件了。

引數資訊：

@author   //作者名
@version  //版本號
@since    //指明需要最早使用的jdk版本
@param    //引數名
@return   //返回值情況
@throws   //異常丟擲情況

例如：

package com.AmazingMing.study;

/**
 * @author AmazingMing
 * @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;
    }
}
 

2.通過命令列生成JavaDoc文件

①右鍵類，找到Open In中Explorer在資料夾中開啟。

②在導航欄前面輸入cmd+空格，回車跳轉到當前資料夾下的命令列

③在命令視窗下輸入：

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

加入引數防止亂碼問題：

-encoding UTF-8 -charset UTF-8
//使編碼格式為UTF-8，字元格式為UTF-8，解決GBK亂碼問題

④輸入完命令後回車，出現以下指令：

⑤回到剛剛開啟的資料夾，這時發現新生成了很多HTML檔案，找到index.html，首頁的檔案，雙擊開啟：

⑥進入以後點選Doc類

⑦此時可以檢視程式碼生成的API文件

3.通過IDEA生成JavaDoc文件

①老方法右鍵類，找到Open In中Explorer在資料夾中開啟。

②在資料夾中新建一個用來存放JavaDoc文件的資料夾（也可以建在別處）

③選擇Tools中的Generate JavaDoc

④在Outout directory中寫入將剛剛建立的資料夾地址

⑤在Locale中輸入zh_CN表示中文，在Other command line arguments中輸入-encoding UTF-8 -charset UTF-8防止亂碼，點選OK即可。

⑥開啟新建的JavaDoc資料夾，開啟index.html檔案就可以看到生成的API文件了。