API文档制作

(1)API文档概念：
Application Programming Interface的缩写，简称应用程序接口。该文档记录多个类，接口，枚举类等数据的应用方式和方法，方便程序员快速了解该数据的使用方式。读懂API也是程序员必备技能。
(2)生活中API文档：
词典，说明书…
(3)制作API文档步骤
1)对类，接口和枚举类添加文档注释。
文档注释语法：/** 注释内容 */

/**
 * 面积类（工具类）
 * @author jim
 * @version 1.0
 */
class Area {


    /**
     * 圆周率
     */
    private final static double PI = 3.14;

    /**
     * 求圆的面积
     * @param r 半径
     * @return 圆的面积
     */
    public static double getCircleArea(double r) {
        return PI * r * r;
    }

    /**
     * 求矩形的面积
     * @param height 高
     * @param width 宽
     * @return 矩形的面积
     */
    public static double getSpaceArea(int height, int width) {
        return height * width;
    }
}

2)使用javadoc命令生成API文档
jimdeMacBook-Air:temp jim$ javadoc Area.java
正在加载源文件Area.java…
正在构造 Javadoc 信息…
标准 Doclet 版本 1.8.0_181
正在构建所有程序包和类的树…
正在生成./Area.html…
正在生成./package-frame.html…
正在生成./package-summary.html…
正在生成./package-tree.html…
正在生成./constant-values.html…
正在构建所有程序包和类的索引…
正在生成./overview-tree.html…
正在生成./index-all.html…
正在生成./deprecated-list.html…
正在构建所有类的索引…
正在生成./allclasses-frame.html…
正在生成./allclasses-noframe.html…
正在生成./index.html…
正在生成./help-doc.html…

打开 index.html，参看该类API文档

注意：
1、Area.java，只包含一个类的独立源文件。
2、包名去掉
3、Area类添加public修饰