java中的API文档

API的概念解释:

API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。

java语言为我们提供了一种功能强大的注释形式:文档注释。

如果编写Java源代码时添加了合适的文档注释,然后通过JDK提供的javadoc工具可以直接将源代码里的文档注释提取成为一份系统地API文档。

开发一个大型软件时,需要定义成千上万地类,而且需要很多人来参与开发。每个人都会开发一些类,并在类里面定义一些方法、属性提供给其他人使用,但是其他人怎么知道如何使用这些类和方法呢?

这时候就需要提供一份说明文档,用于说明每个类、每个方法的用途。当其他人使用一个类或一个方法时,他无须关心这个类的或这个方法的具体实现,他只需要知道这个类或这个方法的功能即可。然后使用这个类或方法来实现具体的目的,也就是通过调用应用程序接口(API)来编程。

API文档就是用以说明这些应用程序接口的文档。

对于java语言而言,API文档通常详细说明了每个类、每个方法的功能、用法等等。


如何下载JDK的API文档呢,so easy。

点击此处下载API文档,下载里面的“Java SE X Documentation”项,通过该下载项下载Java SE X文档,这份文档里包含了JDK的API文档。下载成功后得到一个.-doc.zip文件,解压之后会得到一个docs文件夹,这个文件夹内就是JDK文档,JDK文档不仅包含了API文档,还包含了JDK的其他说明文档,如果直接打开docs文件夹下的index.html文件,将会看到JDK 说明文档的网页。

猜你喜欢

转载自blog.csdn.net/dyd850804/article/details/80555785