JavaDoc生成文档

• javadoc命令是用来生成自己的api文档的

• 参数信息

  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况

• 文档生成

1. 命令行方法：
   进入类所在的路径，dos窗口输入：javadoc -encoding UTF-8 -charset UTF-8 类名.java
   生成的index.html即为文档首页
2. IDEA方法：
   第一步：在工具栏中找到 Tool，然后再子菜单中找到 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 其他参数（设置utf-8，防止中文乱码）
   9. Maximum heep… 最大堆栈