12.JavaDoc生成文件

JavaDoc

javadoc命令是用來生成自己API文件的

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

package operator;
//類註釋
/**
 * @author SHEN
 * @version 1.0
 * @since 1.8
 */
public class doc {
//方法註釋（先寫這段方法，再/**+enter,自動註釋了一些資訊）
    /**
     * @author SHEN
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{//方法
        return name;
    }
}
 

開啟資料夾

1.地址頭部輸入cmd

或者覆蓋位址列輸入cmd

或者按shift右鍵擊資料夾空白處就有在此處開啟命令窗回

2.javadoc -encoding UTF-8 -charset UTF-8 Doc.java把java檔案編譯成一份文件

這是通過命令列javadoc 引數 java檔案

javadoc java生成文件

加引數：為了多顯示一點中文。萬一遇到亂碼問題，可以解決。
-encoding UTF-8文件中如果有中文就設定編碼(encoding-編碼)為UTF-8
-charset UTF-8字符集編碼也是UTF-8

開啟資料夾中生成的index.html（即 首頁）

作業: