Java学习笔记51——帮助文档（API） 制作数组工具类

示例：制作数组工具类（ArrayTool）

 

/**
 * 工具类要把无参构造方法私有化然后工具类的方法用static修饰
 * 这样别人在使用时就只能通过类名来调用你的工具类的方法了.
 *
 * 格式：
 *     首先在最前面通过文档注释写出这是一个具有什么功能的工具类
 *     然后加上   @author 作者名    @version 版本号--版本号前面一般会有一个V
 *
 * 例如：
 * 这是针对数组相关操作的工具类(还在补充优化中)
 *
 * @author 小虎
 * @version V1.0
 *
 */
public class ArrayTool {
    /**
     *  这是私有的无参构造方法
     */
    private ArrayTool(){

    }


    /**
     *
     * 这是遍历数组的方法，遍历后的格式是[元素1,元素2,...]
     * @param array 这是调用方法时传入的参数，数据类型是int类型的数组
     */
    public static void printArray(int[] array){
        for (int i = 0; i < array.length; i++) {
            if (i == 0) {
                System.out.print("[" + array[i] + ",");
            } else if (i == array.length - 1) {
                System.out.print(array[i] + "]");
            } else {
                System.out.print(array[i] + ",");
            }
        }
    }


    /**
     *
     * 这是获取数组元素中最大值的方法
     * @param array 这是调用该方法需要传入的参数，数据类型是int类型的数组
     * @return 返回的是该数组中元素的最大值
     */
    public static int getMaxNum(int[] array){
        int max = array[0];
        for (int i = 1; i < array.length; i++) {
            if (array[i] > max) {
                max = array[i];
            }
        }
        return max;
    }
}

/**
 *      文档注释：
 *          格式：/星星 ... 星/
 *
 *      如何通过文档注释制作一个说明书呢？
 *          1、写一个工具类
 *          2、在工具类中加入文档注释
 *              怎么加？请看ArrayTool中的文档注释
 *              加什么东西呢？
 *                  作者，版本，方法中参数，返回值等等
 *              怎么用呢？
 *                  javadoc -d 目录 -author -version ArrayTool.java
 */
public class ArrayDemo {
    public static void main(String[] args) {
        //定义一个数组
        int[] arr = {11, 22, 33, 44, 42, 12, 13};

        //需求：遍历数组并打印
//        for (int i = 0; i < arr.length; i++) {
//            if (i == 0) {
//                System.out.print("[" + arr[i] + ",");
//            } else if (i == arr.length - 1) {
//                System.out.print(arr[i] + "]");
//            } else {
//                System.out.print(arr[i] + ",");
//            }
//        }

        //需求：输出数组中的最大值
//        int max = arr[0];
//        for (int i = 1; i < arr.length; i++) {
//            if (arr[i] > max) {
//                max = arr[i];
//            }
//        }
//        System.out.println("数值中的最大值为：" + max);

        //将来如果我的代码中有很多地方都需要打印数组功能以及求最大值功能
        //都要再写一遍一样的代码
        //所以我们一个功能封装成一个方法


//        printArray(arr);
//        System.out.println("===================================");
//        int maxNum = getMaxNum(arr);
//        System.out.println("数值中的最大值为：" + maxNum);

        //使用自定义工具类改进一下
        //创建工具类对象
//        ArrayTool arrayTool = new ArrayTool();
//        arrayTool.printArray(arr);

        //直接通过类名调用方法
        //遍历数组
        ArrayTool.printArray(arr);

        //不能让别的程序可以创建工具类对象
//        ArrayTool arrayTool = new ArrayTool();
        //构造方法私有化的类似的工具类，我们在今后的学习中经常遇到

    }

//    /*
//        遍历数组的方法
//     */
//    public static void printArray(int[] array){
//        for (int i = 0; i < array.length; i++) {
//            if (i == 0) {
//                System.out.print("[" + array[i] + ",");
//            } else if (i == array.length - 1) {
//                System.out.print(array[i] + "]");
//            } else {
//                System.out.print(array[i] + ",");
//            }
//        }
//    }
//
//    /*
//        求数组中最大值的方法
//     */
//    public static int getMaxNum(int[] array){
//        int max = array[0];
//        for (int i = 1; i < array.length; i++) {
//            if (array[i] > max) {
//                max = array[i];
//            }
//        }
//        return max;
//    }

}