java doc

java doc（文档注释）

---

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

参数信息：

• @author 作者名

• @version 版本号

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

• @param参数名

• @return 返回值情况

• @throws异常抛出情况

Overview (Java Platform SE 8 ) (oracle.com)

package example;

/**
 * @author bai
 * @version 1.0
 * @since 1.8
 */
public class Main {
    String name;//属性

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