制作帮助文档

定义一个数组：实现遍历，逆序

之前的方法：

public class ArrayDemo {
    public static void main(String[] args) {
        int[] arr = {21, 32, 55, 11, 2, 10};
        //静态的方法只能访问静态的成员方法
        printArray(arr);
        
        int[] arr2 = niXu(arr);
        printArray(arr2);
    }

    public static void printArray(int[] array) {
        for (int i = 0; i < array.length; i++) {
            if (i == array.length - 1) {
                System.out.print(array[i] + "]");
            } else if (i == 0) {
                System.out.print("[" + array[i] + ",");
            } else {
                System.out.print(array[i] + ",");
            }
        }
        System.out.println();
    }

    public static int[] niXu(int[] array) {
        for (int start = 0, end = array.length - 1; start <= end; start++, end--) {
            int temp = array[start];
            array[start] = array[end];
            array[end] = temp;
        }
        return array;
    }
}

先在我们把数组相关的都放到一个类里面，通过类名.方法名调用

public class ArrayTool {
    private ArrayTool(){

    }

    public static void printArray(int[] array) {
        for (int i = 0; i < array.length; i++) {
            if (i == array.length - 1) {
                System.out.print(array[i] + "]");
            } else if (i == 0) {
                System.out.print("[" + array[i] + ",");
            } else {
                System.out.print(array[i] + ",");
            }
        }
        System.out.println();
    }

    public static int[] niXu(int[] array) {
        for (int start = 0, end = array.length - 1; start <= end; start++, end--) {
            int temp = array[start];
            array[start] = array[end];
            array[end] = temp;
        }
        return array;
    }
}

这个类就叫做工具类

工具类的注意事项：

1）不允许外界随意改动，不能让外界创建对象

    如何让外界不能常见对象呢？——把构造方法私有化 

2）将工具类的方法用static修饰

    可以让外界直接通过类名访问

如何制作帮助文档？

1.先写一个工具类，例如：ArrayTool

2.借助文档注释生成帮助文档

怎么加注释？加什么东西呢？怎么用呢？举例说明

         author——作者

         version——版本

         param——调用方法需要传入的参数

         return——返回值

         怎么用？格式：javadoc -d 生成帮助文档的目录 -author -version 工具类的java文件

                                  -d <directory> 输出帮助文档的目录 需要手动创建

/**
 * 这是针对数组相关操作的工具类
 * @author 王佳琪
 * @version V.1.0
 */

public class ArrayTool {
    /**
     * 这是私有的无参构造方法
     */
    private ArrayTool(){

    }

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

    /**
     * 这是数组逆序的方法
     * @param array 这是调用该方法时需要传入的参数，传入的数据类型是int类型的数组
     * @return 返回逆序后的数组
     */
    public static int[] niXu(int[] array) {
        for (int start = 0, end = array.length - 1; start <= end; start++, end--) {
            int temp = array[start];
            array[start] = array[end];
            array[end] = temp;
        }
        return array;
    }
}

如何查看我们制作出来的帮助文档

第一步：在创建的工具类ArrayTool所在文件夹创建一个新的文件夹（例如：doc），用来存放生成的帮助文档

第二步：把ArrayTool的编码格式改成AHSI

第三步：进入cmd命令页面

第四步：输入命令

第五步：以上表示文档已经生成，在文件夹doc下

第六步：打开index.html，内容如下 

如何使用帮助文档？

1.找到文档，打开文档

2.点击显示，找到索引，出现输入框

3.输入你想要查找的类，例如：Scanner

4.看这个类的结构（需不需要导包）

      成员变量 字段

      构造方法 构造方法

      成员方法 方法

5.看构造方法

6.看成员方法

7.使用