IDEA生成JavaDoc

本文将带领大家在IDAE中生成JavaDoc文档。

---

前言

要生成JavaDoc文档首先需要编写服务JavaDoc规范的类。

这边提供一个简单的模版

/**
 * @author Kareza
 * @version 1.0
 * @since 1.8
 */
public class Hello {

    String name;

    /**
     * @param name
     * @return
     * @throws Exception
     * @author Kareza
     */
    public String test(String name) throws Exception {
        return name + "\tKareza";
    }

}

上面这个Hello类简单的定义了JavaDoc中的类注释和方法注释。

在JavaDoc中提供了更丰富的字段，不在本文的讨论范围内，如有需要，请自行查找资料学习。

正文

1. 点击菜单栏中的tools按钮，打开tools菜单。

2. 选择Generate JavaDoc…选项

3. 在弹出的窗口中配置一些相关的参数。

主要有三处：

• 需要生成JavaDoc文档的类（可以是一个或者多个）
• 生成的文档存放的目录
• 编码格式（主要用于识别注释中的中文，防止乱码）
  

4. 可以在IDEA的Run窗口中看到JavaDoc过程中输出的一些信息
   
5. 生成的JavaDoc文档会直接使用默认浏览器打开
   
6. 也可以在配置的输出文件夹中查看到JavaDoc文件