1、javadoc简介

• javadoc 命令时用来生成自己API文档的
• 常用的参考信息如下：
  • @author： 作者名
  • @version：版本号
  • @since：致命需要最早使用的jdk版本
  • @param：参数名
  • @return：返回值情况
  • @throws：异常抛出情况

2、使用命令行方式生成api文档

• 1、新建一个类文件，内容如下：有类的文档说明，也有一个方法的文档说明

package com.redrose2100.base;

/**
 * @author redrose2100
 * @version 1.0.1
 * @since 1.8
 */
public class Doc {
    String name;

    /**
     * @author redrose2100
     * @param name 名字
     * @return  返回名字
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

• 2、从cmd中进入当当前文件的目录，执行如下命令：

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

• 3、此时api文档已经生成完成了，打开目录可以发现生成一堆文件，此时双击打开index.html文件，即可以看到此类的帮转文档了
  

3、使用Intellij IDEA方式生成api文档

• 1、打开【Tools】-【Generate JavaDoc】，然后按照如下设置
  

说明：

1.Whole project:整个项目都生成文档

2.Custom scope 自定义范围。如下：

（1）project files 项目文件，

（2）project production files 项目产品文件，

（3）project test files 项目的测试文件， 未知范围，class hierarchy 类层

3.include test source 包含测试目录

4.include JDK and … 包含jdk和其他的第三方jar

5.link to JDK documentation…链接到JDK api

6.output directy 生成的文档存放的位置

（1）private、package、protected、public 生成文档的级别（类和方法）

（2）右边的Generate…是选择生成的文档包含的内容，层级树、导航、索引…

（3）再右边是生成的文档包含的内容信息，作者版本等信息

7.Locale 语言类型,zh-CN

8.Other command line arguments 其他参数
为支持中文，可填入如下参数：-encoding UTF-8 -charset UTF-8

9.Maximum heep… 最大堆栈

• 2、生成后打开页面如下：