Java中如何制作一个文档说明书

数组工具类：数组工具类里面提供针对数组进行的操作。例如：遍历数组

public class ArrayTool {
将无参构造私有化,目的是为了让外界不能访问
    private ArrayTool() {

    }

    直接定义成员方法.printArray()遍历数组
    public  static void printArray(int[] arr) {
        System.out.print([);
        for(int x = 0 ; x  arr.length ;x++) {
            判断
            if(x==arr.length-1) {
                System.out.println(arr[x]+]);
            }else {
                System.out.print(arr[x]+, );
            }
        }
    }
}

如何制作一个文档说明书

1）创建一个数组,静态初始化
2）创建一个工具类,ArrayTool,提供一些静态功能：遍历,最大值,索引
3）ArrayTool，每类、方法前加上文档注释
4）打开dos控制台：找到当前路径，输入 javadoc -d 目录名 -author -version ArrayTool.java

ArrayDemo类：

import java.util.Scanner;

/**
  需求自定义一个数组,遍历数组
  制作文档说明书
       可以定义一个ArrayTool,数组操作的工具类
       在工具类,必须文档注释,来让解析成文档
       在数组工具类ArrayTool,提供遍历功能,获取最大值的,查找数组中某个元素第一次出现的索引
  @author Administrator
 */

public class ArrayDemo {
    public static void main(String[] args) {
        Scanner sc = new Scanner(System.in);
        int[] arr = {10,20,30,40,50};
        System.out.print(数组遍历为：);
        ArrayTest.printArray(arr);
        int max = ArrayTest.getMax(arr);
        System.out.println(最大值为：+max);
        System.out.print(请输入您要查找的数：);
        int value = sc.nextInt();
        int index = ArrayTest.getIndex(arr,value);
        System.out.println(索引为：+index);
    }
}

ArrayTool类：

/**
  当前这个ArrayTool这个类是针对数组操作的工具类,里面提供了遍历数组以及获取数组的最大值和
  查找数组中第一次出现的索引这些功能
  @author 王子泉
  @version V1.0
 */
public class ArrayTest {
    private ArrayTest() {

    }

/**     当前这个方法是针对数组遍历的功能
        @param arr 需要遍历的数组
*/     
    public static void printArray(int[] arr) {
        System.out.print([);
        for(int i=0;iarr.length;i++)
        {
            if(i==arr.length-1)
            {
                System.out.println(arr[i]+]);
            }else
            {
                System.out.print(arr[i]+,);
            }
        }
    }

/**   当前这个方法是针对数组求最大值的功能
      @param arr 需要遍历的数组
      @return 返回数组最大值
*/
    public static int getMax(int[] arr) {
        int max = arr[0];
        for(int i=1;iarr.length;i++)
        {
            if(arr[i]max)
            {
                max = arr[i];
            }
        }
        return max;
    }

      当前这个方法是针对数组求索引的功能
      @param arr 
      @param value 
      @return 

    public static int getIndex(int[] arr,int value) {
        int index = -1 ;
        for(int i=0;iarr.length;i++)
        {
            if(arr[i]==value)
            {
                index = i ;
                break;
            }
        }
        return index;
    }
}

如何使用文档说明书：
进入jdk文档之后，点击显示—索引—-查询哪个类，例如：Scanner，然后找到官方提供的类。
需要观察：
1）该类中有没有字段
2）该类中有没有构造方法
3）该类中有没有成员方法
4）jdk的版本号