JAVA 文檔注釋，類的說明，HTML說明文檔的產生

標籤：

有的時候，我們會寫一些類，編譯成.class檔案，給別人使用，那麼，別人不知道這個類有哪些方法，如何調用。

所以我們需要做一個類的說明文檔。

可以採用在.java類裡面進行注釋，通過注釋來產生類的說明文檔的方法。

一、.java中注釋的寫法：

Test1.java

/*文檔注釋*//**此類是對數組進行取最值，排序等操作的@author 張三@version 1.0*/public class Test1{    /**    取Int數組裡面的最大值    @param arr 傳入一個int數組    @return 返回一個Int數值    */    public static int max(int[] arr){        int j    =    arr[0];        for(int i=0;i<arr.length;i++){            if(j<arr[i]){                j    =    arr[i];            }        }        return j;    }    /**    取Int數組裡面的最小值    @param arr 傳入一個int數組    @return 返回一個Int數值    */    public static int x(int[] arr){        int j    =    arr[0];        for(int i=0;i<arr.length;i++){            if(j>arr[i]){                j    =    arr[i];            }        }        return j;    }}

ps：

注釋採用/**開始，用*/結尾

@author 作者

@version 版本

@param arr 傳入的值           （arr是方法參數名稱，是什麼參數名，這裡填寫什麼，後面“傳入的值”，這幾個字是參數名的說明）

@return 返回的值                （返回什麼填寫什麼，前面，“返回的值”這幾個字是傳回值的說明）

注意：此類要寫public 否則無法產生說明文檔 

二、在dos中採用以下命令產生說明文檔

javadoc -d Mydoc1 -author -version Test1.java

ps：

1、以上命令Mydoc1是產生後的檔案儲存目錄

2、-author是產生作者

3、-version是產生版本號碼

 

三、產生後的說明文檔檔案結構：

產生後，儲存的檔案是網頁檔案.html的，雙擊index.html即可用瀏覽器開啟查看

查看效果：

 

在這個說明文檔中，有建構函式的說明，如果我們需要取消，只需要把建構函式定義為私人的，就可以了，代碼如下：

/*文檔注釋*//**此類是對數組進行取最值，排序等操作的@author 張三@version 1.0@addDate 2015-05-31*/public class Test1{    private Test1(){            }    /**    取Int數組裡面的最大值    @param arr 傳入一個int數組    @return 返回一個Int數值    */    public static int max(int[] arr){        int j    =    arr[0];        for(int i=0;i<arr.length;i++){            if(j<arr[i]){                j    =    arr[i];            }        }        return j;    }    /**    取Int數組裡面的最小值    @param arr 傳入一個int數組    @return 返回一個Int數值    */    public static int x(int[] arr){        int j    =    arr[0];        for(int i=0;i<arr.length;i++){            if(j>arr[i]){                j    =    arr[i];            }        }        return j;    }}

 

JAVA 文檔注釋，類的說明，HTML說明文檔的產生