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 文件