Java基础语法-Doc文档

JavaDoc

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

参数信息：

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

/**
 * @author ycy
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;


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