idea 自动生成apidoc

矫情吗；* 2022-04-24 12:40 562阅读 0赞

## 一、在工具栏中找到 tool >> Generate JAVADoc ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbG9uZ2h1YW5nMTU3NDA1_size_16_color_FFFFFF_t_70]

## 二、 自定义选择 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbG9uZ2h1YW5nMTU3NDA1_size_16_color_FFFFFF_t_70 1]

1.  Whole project ： 整个项目都生成
2.  Uncommitted files ： 没有提交的文件
3.  Custom scope： 自定义范围 ：project files 项目文件，project production files 项目产品文件，project test files 项目的测试文件， 未知范围，class hierarchy 类层
4.  include test source： 包含测试目录
5.  include JDK and library sources in -sourcepath：包含jdk和其他的第三方jar
6.  link to JDK documentation (user-link option) ： 链接到JDK api
7.  Output directy： 生成的文档存放的位置
8.  private、package、protected、public ：生成文档的级别（类和方法）
9.  右边的Generate…是选择生成的文档包含的内容,依次对应顺序：层级树 导航 索引 单独的字母索引
10. 再右边是生成的文档包含的内容信息,依次对应顺序：使用 作者 版本 废弃 废弃名单
11. Locale 语言类型,zh-CN 中文
12. Other command line arguments: 其他参数
13. Maximum heep size (Mb)： 最大堆栈

*注：本文设置 -encoding UTF-8 -charset UTF-8 -windowtitle “test” 设置了编码字符集都是utf-8，并设备文档标签标题*

点击ok 。

## 三、验证查看 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbG9uZ2h1YW5nMTU3NDA1_size_16_color_FFFFFF_t_70 2]

浏览器打开 如图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbG9uZ2h1YW5nMTU3NDA1_size_16_color_FFFFFF_t_70 3]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbG9uZ2h1YW5nMTU3NDA1_size_16_color_FFFFFF_t_70]: /images/20220215/ba9e1223132c4c77b6ab194abd175986.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbG9uZ2h1YW5nMTU3NDA1_size_16_color_FFFFFF_t_70 1]: /images/20220215/a05369398c6746d5b3220f1f54362b79.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbG9uZ2h1YW5nMTU3NDA1_size_16_color_FFFFFF_t_70 2]: /images/20220215/b5dbbb3f05de4724a12921e61370162a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JlbG9uZ2h1YW5nMTU3NDA1_size_16_color_FFFFFF_t_70 3]: /images/20220215/d6f7a16563d544d894740106799a28ac.png