JavaDoc

javadoc命令是用来生成自己的API文档(帮助文档)的，需要配合注解使用

参数信息

​ @author 作者名

​ @version 版本号

​ @since jdk版本

​ @param 参数名

​ @return 返回值情况

​ @throws 异常抛出情况

package com.yangtao.base;

/**
 * @author yangtao
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

    /**
     * @author yangtao
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

生成java帮助文档

在源文件目录下打开cmd

输入javadoc 文件名

在创建文档的同时设置文档编码

​ -encoding 源文件编码名称

​ -charset 用于跨平台查看生成的文档的字符集

​ javadoc -encoding UTF-8 -charset UTF-8 Doc.java

​ javadoc -encoding 编码名 -charset 编码名 文件名

创建成功后打开index.html文件进入帮助文档主界面