如何能夠看懂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值的絕對值(我們在使用這種方法的時候不用深究這個方法是如何具體實現的,只要知道怎么用就行了)

當有時我們對這個方法還是不太了解的時候我們可以點方法名,這樣的話我們就會看到更加詳細的說明

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM