Java 文档注释

/**
建立一个用于操作数组的工具类, 其中包含着常见的对数组操作的函数, 如: 求最值, 排序等
@author 张三
@version v1.0
*/

public class ArrayTool  // public 作用: 保证文件名和类名必须一致, 否则编译失败.  类的权限更大
{
    private ArrayTool(){}  // 该类中的方法都是静态的, 所以不需要创建对象,使用类即可调用方法.
                           // 为了保证不让其成功创建该类对象, 可以将构造函数私有化

    /**
    获取整型数组的最大值.
    @param arr 接收一个元素为 int 类型的数组
    @return 该数组中最大的元素值
    */
    public static int getMax(int[] arr)
    {
        int maxIndex = 0;
        for(int x=1; x<arr.length; x++)
        {
            if(arr[x]>arr[maxIndex])
                maxIndex = x;
        }

        return arr[maxIndex];
    }

    /**
    对数组进行选择排序
    @param arr 接收一个元素为 int 类型的数组
    */
    public static void selectSort(int[] arr)
    {
        for(int x=0; x<arr.length-1; x++)
        {
            for(int y=x+1; y<arr.length; y++)
            {
                if(arr[x]>arr[y])
                    swap(arr,x,y);
            }
        }
    }

    /**
    用于给数组进行元素的位置置换
    @param arr 接收一个元素为 int 类型的数组
    @param a 接收数组中的一个元素 a
    @param b 接收数组中的另一个元素 b
    */
    private static void swap(int[]arr, int a, int b)
    {
        int temp = arr[a];
        arr[a] = arr[b];
        arr[b] = temp;
    }

    /**
    获取指定的元素在指定数组中的位置
    @param arr 接收一个元素为 int 类型的数组
    @param key 要找的元素
    @return 返回该元素第一次出现的位置, 如果不存在,返回 -1
    */
    public static int getIndex(int[] arr, int key)
    {
        for(int x=0; x<arr.length; x++)
        {
            if(arr[x]==key)
                return x;
        }    
        return -1;
    }

    /**
    将 int 数组转换成字符串, 格式是: [e1, e2, e3...]
    @param arr 接收一个元素为 int 类型的数组
    @return 返回该数组的字符串表现形式
    */
    public static String arrayToString(int[] arr)
    {
        String str = "[";

        for(int x=0; x<arr.length; x++)
        {
            if(x!=arr.length-1)
                str = str + arr[x] + ",";
            else
                str = str + arr[x] + "]";
        }
        return str;
    }
}

文档注释: javadoc -d myhelp -author -version ArrayTool.java
文档注释不能提取 private 方法, 只能提取共有或被保护的方法.
表示在当前目录下新建 myhelp 文件, 并将生成的文档保存到目录 myhelp 下, 可以打开 index.html 查看效果.

_参考资料:_ - [JavaSE 基础视频](https://www.bilibili.com/video/av3092292/#page=3)