IDEA —— 生成项目API

IDEA —— 生成项目API

简介

通过Intellij IDEA 生成 Java doc。方便我们查看项目中的类和函数，首先，我们在研发初期一定要很好的遵循Java编码规范，类注释，方法注释，参数注释一定要全和完整。

如何使用？

IDEA -> Tools ->Generate JavaDoc scope

说明

Generate JavaDoc scope

生成范围

• Whole Project
  整个项目，按项目生成。
• File
  指定文件（当在IDEA先点击一个，再点击生成，会按照所选文件生成）
• Custom scope
  自定义范围

Output directory

输出位置

---

其它

• private
  私有
• package
  包
• protected
  被保护的
• public
  公共的

---

• Generate hierarchy tree
  生成项目结构树
• Generate navigation bar
  生成导航栏
• Generate index
  生成索引，可根据文件首字母A——Z搜索
• Separate index per letter
  每个字母单独索引

---

• @use
  使用中的
• @author
  创建人
• @version
  版本信息
• @deprecated
  弃用的
• deprecated list
  弃用的列表

Local

地区

• zh_CN
  中国

Other command line arguments

其它命令，例子中我输入的是文档编码和字符集规则。

• encoding UTF-8 -charset UTF-8

Maximum heap size (Mb)

最大堆大小。

Open generated documentation in browser

生成后，自动打开。

导出结果示例

和Web版的Java API 类似。