JAVA基础：JavaDoc生成文档

JAVA基础：JavaDoc生成文档

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

API

API 是“Application Programming Interface”的缩写，中文意思是“应用程序编程接口”。

java中的API

[JAVA官方网站中的API](Overview (Java Platform SE 8 ))

我们可以调用这些接口（API）来使用，同时，我们也可以写一个自己的API，API文档包括了这个API的一些信息。

编写Doc

使用文档注释的形式编写

• Doc参数信息

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

• 类的Doc

  /**
   * @author lhy
   * @version 1.0
   * @since 1.8
   */
  public class Doc {
  }
  

• 方法的Doc

  /**
  * @param args
  */
  public static void main(String[] args) {
          
  }
  

生成Doc文档

1. 使用命令行窗口生成

   • 打开cmd，进入Doc.java文件所在位置

   • 输入命令

     javadoc -encoding UTF-8 -charset UTF-8 Doc.java
     

     

   • 文件夹中多出许多.html文件，打开index.html

     

   • 显示Doc类，点进去就是刚才编写的API信息

     

2. 使用IDEA生成Doc文档

   • 点击IDEA左上角tools->Generate javaDoc

     

   • 填写信息