JavaDoc

JavaDoc命令是用来生成自己的API文档的

---

· 一些参数信息：

1. @author：作者名

2. @version：版本号

3. @since：指明需要最早使用的jdk版本

4. @param：参数名

5. @return：返回值情况

6. @throws：异常抛出情况

---

//类注释
/**
 * @author chenyang  作者名
 * @version 1.0   版本号
 * @since 22.0.1   指明需要最早使用的JDK版本
 */
public class Doc {

    String name;  //属性

    //方法注释
    /**
     *
     * @param name  参数
     * @return  返回值情况
     * @throws Exception  异常抛出情况
     */

    public String test(String name) throws Exception{  //方法
        return name;
    }
}

---

生成文档方法：

1.打开类的地址

2. 导航栏打开cmd

3. 输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java

4. 完成查看

---

也可以通过IDEA来生成Java文档，很多博客都有介绍，不做赘述。

https://www.cnblogs.com/bqg2233/p/16907969.html