api帮助文档 hadoop api帮助文档怎么写

面向对象(9_2)：制作以及使用帮助文档(API)

一、制作帮助文档

1、文档注释的格式：

/星星.........星/

2、通过文档注释制作一个说明书

（1）写一个工具类

（2）在工具类中加入文档注释：作者，版本，方法中参数，返回值......

（3）创建帮助文档(API)

步骤：
①在IDEA中，右击ArrayTool文件，点击Show in Explorer

②双击文件ArrayTool.java，另存为，格式改为ANSI

③cmd进入命令栏，输入 javadoc -d 目录 -author -version ArrayTool.java 回车

④返回文件夹，会生成很多的东西，选择 index.html 打开，会看到我们自制的帮助文档已制作成功

3、在Java程序中，已经为我们提供了帮助文档，包含很多我们所需要的工具类，

名字为 jdkapi1.8.CHM

二、使用帮助文档

1、通过API学习MAth类：双击jdkapi1.8.CHM，点击左上角索引，输入MAth回车。

Math:Math类包含执行基本数字运算的方法，如基本指数，对数，平方根和三角函数。

属于哪个包下面的（看使用该类需不需要导包）：
    注意：今后学习过程中，发现一个类在java.lang包下的时候，在代码中时，不需要导包
    （1）通过在API中寻找，发现Math类没有构造方法（说明工具类将方法私有化了）
    （2）Math类中的方法都是被static关键字修饰的，所以今后使用的时候直接通过类名调用

2、学习Math类中的random()方法

例1：调取Math类中的random()方法

public class MathDEmo {
    public static void main(String[] args) {
        //直接调用 Math.random();
        //因为有返回值，需要定义变量接收
        double random = Math.random();
        System.out.println(random);//打印出来的是一个随机的小数
    }
}
        执行结果如下：
        0.879261622435658

        Process finished with exit code 0

例2：需求：获取1-100之间的随机整数

public class MathDEmo {
    public static void main(String[] args) {
        /*
            因为 0.0<= 该方法返回值 <1.0，想要取到1-100之间的整数
            则返回值需要*100，然后再加1
         */
        //因为有返回值，需要定义变量接收
        int x = (int)(Math.random()*100+1);	//强转需要加int
        System.out.println(x);//打印的是一个随机数
    }
}
            执行结果为：
                    62

                    Process finished with exit code 0

例3：需求：获取100个1-100之间的随机整数

public class MathDEmo {
    public static void main(String[] args) {
		//使用for循环
        for(int i =1;i<=100;i++){
            int x = (int)(Math.random()*100+1);
            System.out.println(x);
        }
    }
}

3、学习学习Math类中的max()方法

例：获取两个数中的最大值
public class MathDEmo {
    public static void main(String[] args) {
        //需求：比较两个int类型数值的大小打印最大值
        int a = 66;
        int b = 88;
        int max = Math.max(a,b);
        System.out.println(max);

    }
}