JavaDoc文档生成

JavaDoc文档生成方法

package jie.jie.JavaDoc;

/**
 * @author jie    //作者名
 * @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;
    }
}

1.命令行输出方法

进入对应文件夹目录后按住shift进入dos命令行运行以下代码
javadoc -encoding UTF-8 -charset UTF-8 Doc.java

2.IDEA自带生成JavaDoc方法

选择你生成文件的具体位置

1.选择是整个项目还是模块还是单个文件
2.文档输出路径
3.Locale 选择地区，这个决定了文档的语言，中文就是zh_CN
4.传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api
生成完毕