JavaDoc

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

参数信息

• @author 作者名

• @version 版本号

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

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

/**
 * @author wang
 * @version  1.0
 * @since 1.8
 */
public class DocDemo {
    String name;
​
    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

说明：加在类上面就是类的文档注释，加在方法上面就是方法的注释

1. Java类写好后，找到文件所在路径，进入文档所在文件夹下，用命令行执行javadoc

   

    

    

   命令：javadoc -encoding UTF-8 -charset UTF-8 DocDemo.java

   javadoc java生成文档

   -encoding UTF-8 -charset UTF-8 设置编码格式为UTF-8，并且设置字符集编码为UTF-8，这些参数可解决乱码问题

2. 回到java文件所在路径，发现生成了一些文件，其中,index.html即为api文档首页

   

    

    

3. 双击打开生成的api文档首页