java基础——JavaDoc

JavaDoc

Java API 1.6_Java API中文文档_Java API文档在线 - Java中文网 (javaweb.cc)

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

/**
 * @author 王旭阳  姓名
 * @version 1.0 版本
 * @since 1.8 jdk版本
 */
public class Demo08 {
    String name;

    /**
     *
     * @param name 参数名
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

生成帮助文档

javadoc -encoding UTF-8 -charset UTF-8

idea生成帮助文档