JavaDoc

JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API,易读且清晰明了。

参数信息

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

package base;
/**
* 类的注释
* @author TTjango
* @version 1.0
* @since 1.8
*/
public class Doc {
    
    String name;

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