Java基础-JavaDoc文档生成

使用JavaDoc生成文档，就一定要写出代码的文档注释，关于注释的文章可以查看博主关于Java注释的文章。
下面列举博主觉得常用的一些文档注释标签：

标签	作用
@author	标志编写的作者
@exception	标志抛出的异常
@param	说明一个方法的参数
@return	说明方法的返回值类型
@since	说明该程序的JDK开始版本
@throws	和@exception标签一样
@version	说明版本

我们先看一下JDK的标准文档，JDK8官方文档

下面博主介绍两种方式，一种为cmd窗口生成，一种为IDEA生成。

CMD方法

关于JavaDoc文档的生成，采用的也是javadoc这个命令。
我们使用cmd窗口进入我们需要生成文档的类的文件目录中，输入javadoc -help命令，我们会发现有很多的提示：

我们可以按照我们的需要来选择输出doc文档的命令参数，这里博主演示一个类的文档生成作为演示。

package cn.ara.base;

/**
 * @author Ara_Hu
 * @version 1.0.0
 * @since 1.8
 */
public class Circle {
    //半径
    private double radius;

    public Circle() {
    }

    public Circle(double radius) {
        this.radius = radius;
    }

    /**
     * 获取圆的半径
     * @return 半径
     */
    public double getRadius() {
        return radius;
    }

    /**
     * 设置圆的半径
     * @param radius 半径
     */
    public void setRadius(double radius) {
        this.radius = radius;
    }

    /**
     * 获取圆的周长
     * @return 周长
     */
    public double getPerimeter() {
        return 2 * radius * Math.PI;
    }

    /**
     * 获取圆的面积
     * @return 面积
     */
    public double getArea() {
        return Math.PI * radius * radius;
    }

    @Override
    public String toString() {
        return "Circle{" +
                "radius=" + radius +
                '}';
    }
}

打开cmd，进入该类所在的目录，然后输入javadoc -encoding UTF-8 -charset UTF-8 -d C:\Users\admin\Desktop\Javadoc Circle.java。

• -encoding UTF-8：表示设置编码。
• -charset UTF-8：也表示设置编码。
• -d：表示输出目录。
• Circle.java：表示我们要生成文档的类的java文件。

当我们看到这里，生成文档就已经成功了，这时我们打开我们输出的路径，我们可以看到如下文件：

我们选择index.html打开，我们就能看到与JDK文档类似的文档了。

IDEA方法

我们先在IDEA中打开Circle.java文件，然后选择Tools -> Generate JavaDoc…
打开后会出现如下：

我们根据自己的需求填好其中的内容，点击ok即可。然后我们进入我们输出的文件夹中也会看到如下：

我们还是打开index.html文件，发现与上面CMD输出的文档大体一致：

到此为止，我们就成功的生成了文档。

上述的操作系博主亲自完成，如有不清楚的地方，欢迎留言进行讨论。