JavaDoc

JavaDoc命令是用来生成自己的API文档的（将一些注释信息生成帮助文档）

package video;
/**
 * @author linjing
 * @version 1.5.0
 * @since 1.8
 */
public class Doc {
    String name; //一个属性
    /**
    public String test(String name) throws Exception{ // 一个方法
        return name;
    }

}

此处的文档注释会自动生成下面方法的参数，回车得到如图

package video;

/**
 * @author linjing
 * @version 1.5.0
 * @since 1.8
 */

public class Doc {
    String name; //一个属性

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name) throws Exception{ // 一个方法
        return name;
    }

}

 加在“类”上面就是类的注释，加在”方法“上面就是方法的注释。