1:什么是API文档

API的英文即Application Programming Interface首字母的缩写。不要被这么长的单词吓到，直译过来的意思就是：程序之间的接口文档。再说简单一点类似我们上学期间的字典,想学习java功能我们就需要学会查字典[API]。

2:自定义API文档

想要自定义API文档,就需要先了解注解

2.1 注解

概念：说明程序的。给计算机看的注释：用文字描述程序的。给程序员看的

定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面【框架中就会使用】，用来对这些元素进行说明，注释简单的说：注解就是一个给计算机看的说明【注释】

概念描述：     

JDK1.5之后的新特性   

说明程序的   

使用注解：@注解名称

作用分类   

①编写文档：通过代码里标识的注解生成文档【生成文档doc文档】 

②代码分析：通过代码里标识的注解对代码进行分析【使用反射】 

③编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

2.2 使用注解配合命令生成api

 

3:注意事项

需要注意的是我们华清远见的学生在执行命令的时候 会出现一些问题

1:敲命令的时候需要在指定文件夹里打开 命令窗口

2:需要注意字符编码格式