JAVA文檔註釋

JAVA源碼中註釋方式有3種

//
/*      */
/**     */

其中第三種註釋爲文檔註釋，可以使用javadoc指令生成幫助文檔。

/**
一個文檔註釋的測試類
@author BakingJuly
@version v1.0
*/
//方便起見，方法體已省略
public class  Doc
{

    /**
    用於給數組進行元素置換
    @param arr 接受一個整型數組
    @param a 要進行置換的第一個元素下標
    @param b 要進行置換的第二個元素下標
    */
    private static void swap(int[] arr,int a,int b){}


    /**
    獲取整形數組最大值。
    @param arr 接受一個整型數組
    @return 該數組的最大值
    */
    public static int getMax(int[] arr){return 0;}


    /**
    對數組進行選擇排序
    @param arr 接受一個整型數組
    */
    public static void selectSort(int[] arr){}



    /**
    將整型數組轉換爲字符串
    @param arr 接受一個整型數組
    @return 返回該整型數組的字符串形式
    */
    public static String arrToString(int[] arr)
    {
        String a="";
        return a;
    }
}

控制檯下，使用javadoc方法生成幫助文檔

生成的文件

打開 index.html 文件