如何能够看懂JavaSE帮助文档---API

首先当我们使用帮助文档的时候就是要查某个类或者方法该如何使用，使用的前提条件就是我们知道我们要用帮助文档来查什么东西。就像我们用字典查单词一样，首先我们知道这个单词怎么拼，可能我们不知道这个单词的中文含义，词性，使用方法等等。这些都是通过我们查过词典才知道的。同样的帮助文档就像是我们在查单词时用的字典。

在我们使用帮助文档之前我们首先确定我们要查什么类或方法？

在这里举一个例子，加入我们要查Math这个类

首先打开帮助文档(帮助文档是分平台的，比如说你用的是JavaSE，那你就不能用JavaEE的API来查JavaSE中的类和方法，这个要搞清楚，这两者是有区别的)

首先我们在索引框中打上Math(注意大小写，这里大小写是有区别的)

 

当我们输入完成之后，下面蓝色的部分代表已经选中回车就行。

这个时候右边的显示栏里面会出现这样的内容

 

我们一个一个讲下这都是什么意思。

 

用粗体标记的是这个类的类名(类名首字母大写了)，上面的Java.lang代表包名，这是代表这个类在Java包中的lang包中。

我们这时找到我们当初安装JDK的目录找到JDK文件夹里面的一个src.zip的文件解压，找到java这个文件夹

 

进去找到lang这个文件夹

 

点进去我们就会找到Math这个类

 

当然我们今天的内容不是讲这个的。我们回到正题上。

 

这个意思是说Math的父类时Object类(根类)，既Math继承自Object类。就像文档下面这样说明的一样

 

这个大段文字是对这个类的说明

 

这个说明这个类是从哪个Java版本中开始有的

 

下面的字段摘要用来说明这个类中都有哪些常量，比如说Math类中的常量PI(圆周率π)和自然对数E(e = 1.718281828459045)

 

方法摘要用来告诉我们这个类都有哪些方法我们可以调用

 

方法摘要中左边的这一列用来说明这个方法的返回值，修饰符等等

 

一下面这个方法为例

 

代表该方法时静态的(可以通过类名.方法名来直接调用)，方法的返回值是Double类型，方法名是abs,方法需要传入一个Double类型的参数。方法的作用是返回Double值的绝对值(我们在使用这种方法的时候不用深究这个方法是如何具体实现的，只要知道怎么用就行了)

当有时我们对这个方法还是不太了解的时候我们可以点方法名，这样的话我们就会看到更加详细的说明