Java基礎之Javadoc的使用
阿新 • • 發佈：2020-11-24
java提供了大量的基礎類供我們使用，但是這麼多的類，方法，我們是怎麼知道的呢？從哪裡可以查到呢？原來Oracle公司在為我們提供這些類的同時也為我們提供了相應的API文件，這些API文件就是告訴我們如何去使用這些類以及這些類的方法。
那麼像這樣的API文件是怎樣製作的呢？
其實java語言提供了一種很強大的註釋功能：文件註釋。我們在編寫原始碼的時候可以為這些程式碼新增合適的註釋，然後通過JDK提供的Javadoc工具直接將原始碼裡的文件註釋提取出來形成一份API文件。
API文件相當於產品說明書，所以Javadoc預設處理public，protected修飾的類，介面，方法，成員變數，構造器，和內部類之前的文件註釋。但是如果想Javadoc提取private修飾的內容也是可以的，只要加上選項 -private 就可以了。
Javadoc的使用
一個java類的文件
javadoc -d apidoc -windowtitle test -doctitle MyApiDoc -header MyClass *.java 多個包的文件
javadoc -d apidoc -windowtitle test -doctitle MyApiDoc -header MyClass pack pack pack
-d<directory> 後面跟文件輸出路徑 -windowtitle <text> 指定字串，用於設定API文件的視窗標題。 -doctitle <html-code> 指定一個HTML文字，用於指定視窗的標。 還有很多，具體請使用javadoc -help 檢視
原始碼的javadoc標記 -@author -@version -@param -@return -@throws -@exception
描述包要在同級目錄下產生一個package.html文件，在<body>標籤裡寫包的描述
例：
HelloWord 資料夾下有 input 和print 兩個資料夾，這兩個資料夾裡都有一個package.html和各自的 .java 檔案。
package input;
/**
*這是input類
*@author zhou
*@version 1.0
*/
public class input{
/**
* 這是get方法
* @param c 形參傳入一個字元
*/
public void get(char c){
System.out.println(c);
}
/**
* 這是gets方法
* @param s 形參傳入一個字串
*/
public void gets(String s){
System.out.println(s);
}
}
package print;
/**
*這是print類
*@author zhou
*@version 1.0
*/
public class print{
/**
* 這是printchar方法
* @param c 形參，傳入一個字串
*/
public void printchar(char c){
System.out.print(c);
}
/**
* 這是printchars方法
* @param s 形參傳入一個字串
*/
public void printchars(String s){
System.out.print(s);
}
}
<body> print描述包 </body>
<body> input描述包 </body>
執行javadoc
C:\Users\HASEE\OneDrive\桌面\java\HelloWord>javadoc -d apidoc -windowtitle test -doctitle MyApiDoc -header MyClass input print
結果：
會在HelloWord資料夾下生成apidoc檔案,apidoc下的index.html就是提取註釋生成的API文件。