Java - 练习任务 | 生成一篇api说明文档（IDEA）

---

Java生产一篇API 文档

四则运算

一，编写程序（注释）

public class Exp05 {
    /**
     * 两个整数求和<br>
     * @param a - 被加数<br>
     * @param b - 加数<br>
     * @return 两个整数求和
     */
    public static int sum(int a, int b) {
        return a + b;
    }

    /**
     * 两个整数求差<br>
     * @param a - 被减数<br>
     * @param b - 减数<br>
     * @return 两个整数求差
     */
    public static int difference(int a, int b) {
        return a - b;
    }
    /**
     * 两个整数求积<br>
     * @param a - 被乘数<br>
     * @param b - 乘数<br>
     * @return 两个整数求积
     */
    public static int product(int a, int b) {
        return a * b;
    }
    /**
     * 两个整数求商<br>
     * @param a - 被除数<br>
     * @param b - 除数<br>
     * @return 两个整数求商
     */
    public static int consult(int a, int b) {
        return a / b;
    }
}

二，使用IDEA生产API说明文档

（一）.将编码改为gbk

1.单击idea右下角的utf-8。（如下图）

2.选中单击gbk，然后弹出下图所示界面，选择concert即可。

（二）.生成文档

1.选择菜单栏中的Tools-Generate JavaDoc。

2.如下图

3.生成文档过程（没有错误即表示生成已经成功）。

4.查看API说明文档。