有的時候，我們會寫一些類，編譯成.class文件，給別人使用，那么，別人不知道這個類有哪些方法，如何調(diào)用。

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

可以采用在.java類里面進(jìn)行注釋，通過注釋來生成類的說明文檔的方法。

一、.java中注釋的寫法：

Test1.java

/*文檔注釋*//**此類是對數(shù)組進(jìn)行取最值，排序等操作的@author 張三@version 1.0*/public class Test1{    /**    取Int數(shù)組里面的最大值    @param arr 傳入一個int數(shù)組    @return 返回一個Int數(shù)值    */    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數(shù)組里面的最小值    @param arr 傳入一個int數(shù)組    @return 返回一個Int數(shù)值    */    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：

注釋采用/**開始，用*/結(jié)尾

@author 作者

@version 版本

@param arr 傳入的值 （arr是方法參數(shù)名稱，是什么參數(shù)名，這里填寫什么，后面“傳入的值”，這幾個字是參數(shù)名的說明）

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

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

二、在dos中采用以下命令生成說明文檔

javadoc -d Mydoc1 -author -version Test1.java

ps：

1、以上命令Mydoc1是生成后的文件保存目錄

2、-author是生成作者

3、-version是生成版本號

三、生成后的說明文檔文件結(jié)構(gòu)截圖：

生成后，保存的文件是網(wǎng)頁文件.html的，雙擊index.html即可用瀏覽器打開查看

查看效果截圖：

在這個說明文檔中，有構(gòu)造函數(shù)的說明，如果我們需要取消，只需要把構(gòu)造函數(shù)定義為私有的，就可以了，代碼如下：

/*文檔注釋*//**此類是對數(shù)組進(jìn)行取最值，排序等操作的@author 張三@version 1.0@addDate 2015-05-31*/public class Test1{    PRivate Test1(){            }    /**    取Int數(shù)組里面的最大值    @param arr 傳入一個int數(shù)組    @return 返回一個Int數(shù)值    */    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數(shù)組里面的最小值    @param arr 傳入一個int數(shù)組    @return 返回一個Int數(shù)值    */    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;    }}