API的概述

API

API的概述

1、API：application programming interface 应用程序编程接口

• API:

  官方提供的JDK类库（Java官方写好的各种类型）

• API帮助文档：

  JDK类库中有很多定好的类型，而且每个类型都有一个对应的帮助文档。

  如果要使用这些类型，就需要借助帮助文档来学习

API帮助文档的使用

• 在线API文档：需要网络访问的应用程序编程接口

• 离线API文档：下载后的应用程序编程接口

  • 索引
  • 输入框中输入需要查看的类型
  • 类型中，会有一个介绍和方法的展示等等

API文档的制作

• 文档注释【不能嵌套】：

格式：
/**
 	 	 	文档注释
*/

• 帮助文档注解：将来可以被文档生成工具解析出来的格式，可以解析出来其中的数据

作者：			 @author 名称
当前版本：		@version v1.0
上一个版本：	   @since 
参数：          @param 
返回值：         @return

如何生成帮助文档

• 点击Tools菜单,选择Generate JavaDoc…
  
  

  注释：

  1、选择是整个项目还是模块还是单个文件

  2、文档输出路径

  3、选择文档的语言，中文就是zh_CN

  4、传入JavaDoc的参数，一般这样写：

  -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

  或者

  -encoding UTF-8 -charset UTF-8