1. 程式人生 > >IntelliJ IDEA-2018.2生成JavaDoc(十七)

IntelliJ IDEA-2018.2生成JavaDoc(十七)

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

    JavaDoc能夠從原始碼中抽取類、屬性、方法等的註釋,形成一個配套的API幫助文件

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


@author  作者名

@version 版本號

@since 指明需要最早使用的jdk版本

@param 引數名

@return 返回值情況

@throws 異常丟擲情況

 生成JavaDoc的步驟是:

 Tools|Generate JavaDoc....

 

彈出對話方塊

1. 選擇是整個專案還是模組還是單個檔案   oop2

2. 文件輸出路徑 Output directory:  c:\oop2

3. Locale 選擇地區,這個決定了文件的語言,中文就是zh_CN

4. 傳入JavaDoc的引數,一般這樣寫

 -encoding UTF-8 -charset UTF-8 -windowtitle "文件HTML頁面標籤的標題" -link http://docs.Oracle.com/javase/7/docs/api

 

生成成功!