JavaDoc文档

Javadoc文档注释–》/**

注解参数：

/**
 *
 * @author    作者名
 * @version   版本号
 * @since   指明需要使用的JDK版本
 * @param 参数名
 * @return 返回值新情况
 * @throws  异常抛出情况
 *
 */

注解加到类上就是类的注释，加到方法上就是方法的注释

/**
 *
 * @author  Wind  作者名
 * @version 1.0  版本号
 * @since 1.8  指明需要使用的JDK版本
 *
 */
public class Doc {
    String name;
    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name)throws Exception{
        return name;
    }

使用命令行生成javadoc文档

javadoc 参数 *.java

找到文件所在文件夹，在这个文件夹中进入CMD命令行，输入命令：

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

执行成功结果：

然后文件夹中问生成对应文件：

点击index.html即可查看生成的文档。

使用IDEA生成javadoc文档

1. IDEA中点击Tools -------》Generate JavaDoc

2. 选择要生成的文档的范围

Whole project–>整个项目

File–>指定文件

Custom scope–>自定义范围，默认全部

3. 选择输出目录

4. 输入其他参数：-encoding UTF-8 -charset UTF-8（否则有中文可能会报错导致生成失败）

5. 点击OK即可生成javaDoc文档。