java中的工具类并创建工具方法文档

ndmtzwdx / 2024-09-25 / 原文

编写一个方法，例如在一个有序数组里查找所需要的数字的下标

public  static void subscript(int[] a) {
            Scanner sc = new Scanner(System.in);
            System.out.println("输入要查找的数：");
            int b = sc.nextInt();
            int x = a[a.length / 2];
            for (int i = 1; i < a.length; i++) {
                if (b == x) {
                    System.out.println("索引为：" + (a.length / (2 * i)));
                    break;
                } else if (b > x) {
                    i=a.length/2;
                    x=x+a.length/(2*i)+1;
                } else if (b < x) {
                }
            }
    }

创建一个工具类，将这个方法和其他的关于数组的方法放到其中
以下是所编写的一些计算排序输出的方法

public class ArrayTool {

    private ArrayTool(){}

    /**
     * 该方法是针对元素是int类型数组的逆序
     * @param arr 参数是元素为int类型的一维数组
     * @return 返回排序后的数组地址
     */
    public static int[] niXu2(int[] arr) {
        for (int front = 0, end = arr.length - 1; front < end; front++, end--) {
            int tmp = arr[end];
            arr[end] = arr[front];
            arr[front] = tmp;
        }
        return arr;
    }

    /**
     * 该方法是以指定格式遍历元素为int类型的一维数组
     * 遍历后的结果为[元素1,元素2,...]
     * @param arr 参数是元素为int类型的一维数组
     */
    public static void printIntArray(int[] arr) {
        for (int i = 0; i < arr.length; i++) {
            if (i == 0) {
                System.out.print("[" + arr[i] + ",");
            } else if (i == arr.length - 1) {
                System.out.println(arr[i] + "]");
            } else {
                System.out.print(arr[i] + ",");
            }
        }
    }

    /**
     * 该方法是获取参数是元素为int类型的一维数组中的最大值
     * @param arr 参数是元素为int类型的一维数组
     * @return 返回数组中的最大值
     */
    public static int getMaxNumber(int[] arr){
        int maxNumber = arr[0];

        for (int i = 1; i < arr.length; i++) {
            if (arr[i] > maxNumber) {
                maxNumber = arr[i];
            }
        }
        return maxNumber;
    }

    /**
     *该方法是对传入的两个数求和
     * @param a 参数是元素为double类型的一个数
     * @param b 参数是元素为double
     * @return 返回的类型是double
     */
    public static double SuePeace(double a,double b){
        return a+b;
    }

    /**
     * 该方法是一个利用二分查找来找到所需要的数字的下标
     * @param a 参数为一个有序的数组
     */
    public  static void subscript(int[] a) {
            Scanner sc = new Scanner(System.in);
            System.out.println("输入要查找的数：");
            int b = sc.nextInt();
            int x = a[a.length / 2];
            for (int i = 1; i < a.length; i++) {
                if (b == x) {
                    System.out.println("索引为：" + (a.length / (2 * i)));
                    break;
                } else if (b > x) {
                    i=a.length/2;
                    x=x+a.length/(2*i)+1;
                } else if (b < x) {
                }
            }

    }
}

编写文档注释，就像一个电子产品会有一个说明书一样

/**
     * 该方法是一个利用二分查找来找到所需要的数字的下标    //说明该方法的主要用途以及使用方法
     * @param a 参数为一个有序的数组           //编写所传入参数的类型和要求
     */

/**
     *该方法是对传入的两个数求和
     * @param a 参数是元素为double类型的一个数
     * @param b 参数是元素为double
     * @return 返回的类型是double     //如果该方法的类型是void之外的类型，需要编写一个返回值的类型
     */

如何将其中的文档注释拿到电脑中
将工具类复制一份到任意目录下
用记事本打开