我如何閱讀java文檔？

我正在尋找一些關於如何去閱讀關於java的各種包類和方法的在線文檔的建議。我如何閱讀java文檔？

我的意思是這一切的東西：http://java.sun.com/javase/6/docs/api/

來源

2010-04-05 David

你的意思是你實際上在使用javadocs時遇到麻煩嗎？就像你找不到你想要的類和方法？或者你的意思是說他們對理解Java SDK中的可用功能並不是很有幫助？ – 2010-04-05 02:58:05

我碰巧喜歡這個問題。我個人發現在線Java文檔是一個不可思議的混亂。如果任何人有任何關於如何製作正面或反面的建議，我也想知道！ – 2010-04-05 02:59:08

如果不先嚐試尋找某些東西，你很可能會問這個問題。我懷疑你在提及文檔時遇到了一些麻煩，並且發現它們毫無幫助。你能告訴我們你有什麼問題嗎？ – Cam 2010-04-05 03:29:01

Here's a tutorial。

事實上，只有在需要時才能閱讀。對於剩餘，請閱讀教程。通常谷歌搜索「[關鍵字]教程網站：oracle.com」產生足夠的結果。

更新採取以下，只要你願意爲它找到的Javadoc的例子：

someString.split("\\.");

這裏someString是java.lang.String一個實例。假設你想從API documentation root（）開始，我自己寧願在Firefox的地址欄中輸入「java.lang.string javase api site：oracle.com」以便直接獲取它（如果你覺得幸運並且在瀏覽器歷史記錄中沒有它），或者只是在我的IDE）中檢查它，然後在主框架中滾動到java.lang package並單擊鏈接，然後在課堂摘要中檢查String class並單擊鏈接，然後在方法摘要中檢查split() method並單擊鏈接。

Java SE API的Javadoc非常簡潔，但相當完整，並提供了指向您希望它們的其他javadoc的鏈接。例如，在javadoc的底部，您會看到類似Pattern類的「另請參見」鏈接，該鏈接反過來解釋了類的引言中的正則表達式。

來源

2010-04-05 03:03:34 BalusC

這不是我所問的。這是別的。 – David 2010-04-05 03:05:32

然後你需要澄清更多。如果您曾經質疑過「java.lang.String＃split（String）'究竟做了什麼？」，那麼只需轉到java.lang.String的Javadoc，查找split（）方法並讀取方法文件。點擊你的方式，通過包，類和方法。 – BalusC 2010-04-05 03:06:36

實際上，這可能是我所說的。我真的不知道。 – David 2010-04-05 03:12:45

讀它需要。就像在一個項目中一樣。文檔主要是基於需求的格式，而不是概念教學格式。

否則，如果你想實際上請看以學習SDK爲例，請閱讀教材。

來源

2010-04-05 03:00:39 codenheim

好吧，我想知道我是如何閱讀它，當我需要。 – David 2010-04-05 03:01:02

也許如果你發佈了一些讓你感到困惑的東西，我們可以幫助解密它嗎？ – 2010-04-05 03:01:47

你的意思是你不知道如何訪問它？或者你的意思是你不知道如何找到你需要的東西。這是一個廣泛的信息，這就是爲什麼我建議從一本Java書開始。 – codenheim 2010-04-05 03:02:48

JavaDoc僅僅是一個參考。回答「這是什麼（類/方法）」這個形式的問題非常好？但對於其他任何事情都很糟糕。

如果您對JavaDoc感到困惑，您應該拿起一本書或找到在線教程。使用文檔作爲參考來回答具體問題，也許你不會感到困惑。

來源

2010-04-05 03:01:18

想象一下，你有一個字符串，並且你正試圖解決如何將它轉換爲大寫。看看javadoc的絃樂，在http://java.sun.com/javase/6/docs/api/java/lang/String.html （或從上面的鏈接，只需向下滾動找到字符串在左下方列表。

你會發現有一個方法那裏叫toUpperCase()，你可以點擊它找到詳細信息，然後你會看到所有其他的方法，它們描述了你可以「做」到字符串的各種東西

還有一個構造函數列表，它告訴你如何「創建一個字符串對象

也許對於一個字符串來說不是太難，所以試試更復雜的東西：如何創建一個BufferedOutputStream？

來源

2010-04-05 03:08:53 John

想象一下javadoc在iTunes中瀏覽相冊。左上框是一個包列表。這就像藝術家的名單。選擇左下方框中顯示的變化之一。左下方的框是上面選擇的包中的類/接口列表。這就像選擇一位藝術家並顯示相冊列表。然後，您可以選擇其中一個類/接口，並且其詳細視圖將顯示在主框架中。這就像所選專輯的曲目列表。

除此之外，主框架細節顯示了與該類或接口進行交互所需的所有公共信息和受保護信息。在頂部顯示繼承層次結構和類的描述。下面是所有在該類上公開或保護的字段，構造函數和方法的摘要。您可以點擊任何鏈接以跳轉至完整說明。摘要底部列出了所有繼承的方法。

在javadoc中引用的任何類，如參數或返回類型都是鏈接。如果你點擊鏈接，它將導航到該類的javadoc。通過這種方式，可以很容易地瀏覽所需的所有類，以瞭解發生了什麼。這不完全漂亮，但它的工作原理。作爲html，您甚至可以在新標籤中打開鏈接，因此可以一次輕鬆打開所有相關類。

最後一個提示 - 細節窗格頂部有一些額外的選項。我使用很多的是框架/無框架鏈接。這將添加或刪除左側的包和類框架。如果您在新選項卡中打開其他課程，或者有時如果您使用Google查找課程，則會在沒有額外框架的頁面上結束。只需點擊框架標籤，它們就會被添加到頁面中。

來源

2010-04-05 03:32:49

對於我學習Java SE APIs最有幫助的是做「The Java Tutorials」。它幾乎涵蓋了整個Java SE，而且比JavaDocs更有組織。閱讀完您感興趣的內容後，JavaDoc將自行更有意義。

通常我通過IDE讀取我感興趣的JavaDocs。我使用Netbeans，它會自動顯示JavaDoc作爲其代碼完成的一部分。這樣，我可以部分鍵入一個我正在使用的類或方法名稱，然後瀏覽這些建議的JavaDocs，直到找到我想要的。

來源

2010-04-05 03:33:12 Daniel

我第二個以上所有困惑的用戶。至於我自己使用Windows API for VB classic的狂熱背景，Java API沒有啓發性。

是的，Java API提供了充足的關於自身的信息，每個類的作用和結構;但是，對於開發過程中的任何有用的東西來說，它幾乎不會引用解決方案和可用代碼。

想象一下，任何新到Java的人都難以記得或記住哪些功能是每個軟件包的一部分。然後找到一個方法，函數，類或已經定義的術語使用是一場噩夢。

關於Java的API文檔：對於環境和語言來說，這是一回事;這是一個完全不同的球類比賽，當它更注重簡單地變得與衆不同時，儘管對初學者的眼睛不一致。

我相信人們會發現開始編碼的步驟非常簡單，大大改進了Java的無序API文檔佈局。

來源

2016-06-25 23:09:53

謝謝SoAwesomeMan;）雖然我主要喜歡爲自己說話，但在迴應時強調幾乎沒有好處的語法。介意你英語不是我的第一語言。 – 2016-06-26 11:02:48

我如何閱讀java文檔？

回答

相關問題