帮助文档API的使用和制作

如何制作一个说明书呢？

A：写一个工具类
B：对这个工具类加文档注释
C：用工具解析文档注释
javadoc工具
D：格式；javadoc -d 目录 -author -version ArrayTools.java
目录；可以写一个文件夹的路径，如果只写了文件名就生成在当前文件路径下
-author：读取包含@author段
-version：读取包含@version段
-param和-return是默认读取的不需要再声明
下面是一个针对数组的工具类生成帮助文档API的实例

/**
* 这是针对数组操作的工具类
* @author matty
* @version V.1.0
*/
public class ArrayTools{
    /**
    * 这是私有构造
    */
    private ArrayTools(){}//构造方法私有化
    //遍历数组
    /**
    * 这是遍历数组的方法，遍历后的格式是：[元素1,元素2,元素3,......]
    * @param bb 这是要被遍历的数组
    */
    public static void printArray(int[] bb){/*这里的静态方法还是能够通过创建对象的方法来调用，如何才能限定其只能通过类名调用：构造方法私有化*/
        System.out.print("[");
        for(int x=0;x<bb.length;x++){
            if(x==bb.length-1){
                System.out.println(bb[x]+"]");
            }else{
                System.out.print(bb[x]+",");
            }
        }
    }
    //获取最大值
    /**
    * 这是获取数组中最大元素的方法
    * @param arr 这是要获取最大值的数组
    * @return 返回数组中最大的元素
    */
    /*param是参数的意思，后面跟参数的变量名，ruturn是返回值的意思，后面可以不跟返回值的变量名，能不能跟还有待实践*/
    public static int getMax(int[] arr){
        int max = arr[0];
        for(int x=1;x<arr.length;x++){
            if(arr[x] > max){
                max = arr[x];
            }
        }
        return max;
    }
    //获取索引
    /**
    * 这是获取某一元素在数组中第一次出现的索引方法
    * @param arr 这是要获取索引的数组
    * @param value 这是要获取索引的元素值
    * @return 索引值
    */
    public static int getIndex(int[] arr,int value){
        int index = -1;
        for(int x=0;x<arr.length;x++){
            if(arr[x] == value){
                index = x;
                break;
            }
        }
        return index;
    }
}

如何使用帮助文档

1：打开帮助文档
2：点击显示，找到索引，看到输入框
3：知道你要找的类是什么，以Scanner举例
4：在输入框输入Scanner然后回车
5：看包
java.lang包下的类不需要导入，其它的全部需要导入。

导入：java.util.Scanner
6: 再简单的看看类的解释和说明，别忘了看看类的版本
7：看类的结构；
字段摘要：成员变量
构造方法摘要：构造方法
成员方法：方法摘要
8：具体看构造方法
A：有构造方法：需要创建对象使用
B：没有构造方法：成员可能都是静态的
9：具体看成员方法
左边：
看是否是静态：如果是就可以通过类名调用，如果不是就只能创建对象调用
返回值类型：人家返回什么，你就用什么接受
右边：
看方法名：方法名不要写错
看参数列表：人家要什么，你就给什么，人家要几个，你就写几个

使用帮助文档API调用Math中的random()方法（生成随机数方法）

/*
    猜数字小游戏（数字在1~100之间）
    要求：
        A：程序产生一个随机数。
        B：键盘录入你猜的数字
        C：把你猜的和程序产生的随机数作比较
            a：大了
            b：小了
            c：猜中了
        D：给出多次猜的机会，猜中就结束



*/
import java.util.Scanner;
class GuessNumber{
    public static void main(String[] args){
        //static double random()  返回带正号的 double 值，该值大于等于 0.0 且小于 1.0。 
        int rightnumber = (int)(Math.random()*100)+1;
        while(true){
            System.out.println("请输入一个数");
            Scanner sc = new Scanner(System.in);
            int guessnumber = sc.nextInt();
            if(guessnumber == rightnumber){
                System.out.println("你猜中了");
                break;
            }else if(guessnumber > rightnumber){
                System.out.println("大了");
            }else{
                System.out.println("小了");
            }
        }
    }
}