JavaDoc

1、简介

JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了。
以 /** 开始，每行以*开头以 */ 结束。
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

public class HelloWorld { 
    public String name; 
    /**
    * @param name 姓名 
    * @return 返回name姓名 
    * @throws Exception 无异常抛出 
    * */ 
    public String function(String name) throws Exception{ 
        return name; 
    } 
}

命令行生成Doc

-encoding UTF-8 -charset UTF-8 
//解决GBK乱码问题，在中间添加编码设置