生成javadoc文档

1、javadoc(文档注释）

/**
 * 长这样
 */

2、参数信息：（常用）

@author 作者名

@version 版本号

@since 指明需要使用的jdk版本

@param 参数名

@return 返回值情况

@throws 异常抛出情况

3、编写一段程序

本人使用idea

假设在包里建一个名为1的文件夹,再建一个名为Demo1的java文件

/**
 * @author w
 * @version 1.8
 */
public class Demo1 {
    String name;
    /**
     * @param name
     * @return name
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

4、生成javadoc文档

找到文件所在地址，打开cmd窗口（在文件名前输入cmd，回车）

输入 javadoc -encoding UTF-8 -charset UTF-8 Demo1.java

这时候文件夹里会出现 index.html的文件，打开就是一个javadoc文档了。