java-JavaDoc生成文档

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

参数信息

@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

例子

//类注释
/**
 * @author 小麦
 * @version 1.0
 * @since 1.8
 *
 */

public class JavaDoc {

    String name;

    //方法注释
   /**
     * @author 小麦
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception {
        return name;
    }
}

//可以通过命令行查看文档：javadoc -encoding UTF-8 -charset UTF-8 JavaDoc生成文档.java
//也可通过idea生成JavaDoc文档