idea 自动生成apidoc
一、在工具栏中找到 tool >> Generate JAVADoc
二、 自定义选择
- Whole project ： 整个项目都生成
- Uncommitted files ： 没有提交的文件
- Custom scope： 自定义范围 ：project files 项目文件，project production files 项目产品文件，project test files 项目的测试文件， 未知范围，class hierarchy 类层
- include test source： 包含测试目录
- include JDK and library sources in -sourcepath：包含jdk和其他的第三方jar
- link to JDK documentation (user-link option) ： 链接到JDK api
- Output directy： 生成的文档存放的位置
- private、package、protected、public ：生成文档的级别（类和方法）
- 右边的Generate…是选择生成的文档包含的内容,依次对应顺序：层级树 导航 索引 单独的字母索引
- 再右边是生成的文档包含的内容信息,依次对应顺序：使用 作者 版本 废弃 废弃名单
- Locale 语言类型,zh-CN 中文
- Other command line arguments: 其他参数
- Maximum heep size (Mb)： 最大堆栈
注：本文设置 -encoding UTF-8 -charset UTF-8 -windowtitle “test” 设置了编码字符集都是utf-8，并设备文档标签标题
点击ok 。
三、验证查看
浏览器打开 如图：