javaDoc生成文档

javaDoc

1. JavaDoc命令是生成自己APL文档的
2. 参数信息

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

3. 加在类上面，就是类的注释 ；加在方法里面，就是方法注释
   例如：

/**类的注释
 * @author  wangkang
 * @since 1.8
 * @version  1.0
 */

public class Dome1 {
    String name;
    /**
     *方法的注释
     * @param name
     * @return
     */
     public String test(String name){
         return name;
     }
}