1. 首頁
  2. 問答
  3. 你如何閱讀JavaDoc？

你如何閱讀JavaDoc？

2008-09-16 112 views
28

你使用什麼工具/網站來閱讀JavaDocs？你如何閱讀JavaDoc？

我目前使用的Firefox有20多個標籤頁，當處理J2EE項目時，所有可用的文檔都不可用，內存過多，無法搜索。

我會從這樣的一個工具/網站期待什麼：從不同的地點

  • 骨料的JavaDoc
  • 直接訪問類型，如按Ctrl + T在Eclipse或類似
  • 全文搜索
  • 十字在我選擇的所有Java庫之間引用
  • 對於工具：脫機支持
  • 速度

不是強制性的：（？+版本比較）

  • 可能性註釋東西不同版本的庫
  • 支持
  • IDE集成

編輯：

感謝您的回答。我知道大部分的網站，但給了他們另一個嘗試。這是我的判斷：

  • 內置的Eclipse/IDE功能
    • 緊密集成
    • 離線/在線支持
  • javadoconline.com （不再維護）
    • 作品
    • 整潔外觀
    • 發現在API的多個版本匹配，並允許輕鬆切換
    • 簡單，但工作
    • 快速
  • jdocs （離線）
    • 似乎很複雜
    • 有時慢
    • 某些最近版本的庫似乎已經丟失（Seam 2.0。0時，Hibernate驗證器），但它看起來像你可以自行添加
    • IDE集成（未測試）
    • 維基風格的註釋，以每個項目
  • docjar.com
    • 工作
    • 快速
    • 凌亂的UI
  • javadoc_isearch
    • 針對Firefox的Greasemonkey腳本，使得導航的javadoc容易
    • 工作順利和完美

來源

2008-09-16 jrudolph

+0

除了「交叉引用」上，NetBeans做所有的事情從第一項目列表（並已經做了早在'08） – 2014-07-07 21:45:34

+0

試試這個 - http://javasearch.buggybread.com – 2016-02-16 21:26:27

回答

1

與Eclipse的集成的Javadoc好，有它類似HTML的瀏覽器。您可以將source和javadoc附加到當您選擇一個類時將顯示的二進制文件。

來源

2008-09-16 15:10:59

0

Doxygen（http://www.stack.nl/~dimitri/doxygen/）可能適合該法案。

編輯：我可能誤解了你的問題，doxygen是一個工具來生成基於你的代碼和javadoc的文檔和模型。

來源

2008-09-16 15:11:47 mmattax

+0

你知道了，但是非常感謝; – jrudolph 2008-09-16 15:23:24

1

像這樣的東西可能會有用嗎？

http://www.docjar.com/

來源

2008-09-16 15:13:01

+0

謝謝，是的，我知道這個，但我不喜歡搜索，它沒有導航欄或類似的東西。所有的設計對我來說都不夠乾淨。 – jrudolph 2008-09-16 15:22:49

1

個人而言，我從來沒有與我的IDE提供了內置的javadoc瀏覽工具問題。

目前，我使用IntelliJ Idea - Ctl-Q爲光標下的方法提供了javadoc，並帶有文檔功能其他部分的超鏈接。

我會想象NetBeans和Eclipse提供類似的功能。

來源

2008-09-16 15:15:43

+0

+1正確。爲什麼還要使用其他工具或網站，最簡單的方法就是在您最需要的IDE中閱讀Javadocs。 （獲取外部庫的API文檔（或源代碼）的本地副本，以加速訪問它們。） – Jonik 2009-04-25 19:59:39

2

我對FF使用http://www.teria.com/~koseki/tools/gm/javadoc_isearch/。讓我可以輕鬆瀏覽其他圖書館。

來源

2008-09-16 15:16:44 Swati

+0

這看起來有點過時了。它仍然有效嗎？ – jrudolph 2008-09-16 15:27:21

+0

是的，我測試了它，我非常喜歡它。它速度很快，並且應該如此。好一個。 – jrudolph 2008-09-17 07:26:06

+0

對於Firefox，您只需在位置欄上鍵入以下內容：`jar：file：// <您的zip或jar存檔的路徑>！/`。不要忘記最後的斜線。積分：http://popqvarnstrom.blogspot.pt/2012/03/browsing-jarzip-files-eg-javadoc-in.html – 2016-01-05 11:15:54

8

如果您使用Eclipse，它提供對Javadocs的支持。例如，將鼠標懸停在方法調用上將顯示一個工具提示，向您顯示該方法的Javadoc。開箱即用支持核心Java類的文檔。但是，如果您的項目使用任何其他庫（JAR文件），則需要進行一些配置才能將其Javadoc插入到Eclipse中。

  1. 轉至項目屬性的「Java構建路徑」部分。
  2. 轉到「庫」選項卡並單擊JAR文件旁邊的「加號」圖標。
  3. 點擊「Javadoc location」，然後點擊「Edit ...」按鈕。

這將允許您指定該JAR的Javadoc所在的位置。它甚至會讓你指定一個網站的URL，所以你不必自己下載Javadoc！

來源

2008-09-16 20:10:26 Michael

+0

Thx的確切解釋如何做到這一點。我知道，但可能會有其他人沒有。 – jrudolph 2008-09-17 07:33:52

2

你可以找到斯坦福大學的JavaDoc here。

來源

2009-04-25 19:49:11

+1

我得到了一個404，但也有這個：http://www.stanford.edu/class/cs108/JavaDocFast.html 它只是提供了一些很好的快速鏈接到內置Java類文檔 – MatrixFrog 2009-08-14 18:39:09

1

唔...怎麼樣：

  • http://edu.netbeans.org/quicktour/javadoc.html部分 - NetBeans支持Java文檔的Javadoc標準 - 無論是觀看，併產生了。
  • http://globaldocs.zeevbelkin.com/ - 此應用程序允許通過Internet和本地文件系統方便地瀏覽多個javadoc集，使用單個包/類層次樹和可搜索索引。查看器支持本地和遠程docset（本地docset，打包到JAR/ZIP文件也支持）。

我喜歡的NetBeans，因爲它從Maven的~/.m2目錄自動獲得的JavaDoc ...

來源

2013-02-18 13:19:39 gavenkoa

0

Eclipse是看的javadoc一個最好的方式。將鼠標懸停在方法或任何聲明上，您將通過eclipse自動生成javadocs。

來源

2013-04-19 03:23:57

1

JavaDoc的罐子可以直接解壓縮。從理論上講，任何發佈的javadoc都可以下載並離線查看。

  1. 直接從maven存儲庫下載。例如：http://central.maven.org/maven2/com/googlecode/objectify/objectify/5.0.3/objectify-5.0.3-javadoc.jar

  2. 現在你objectify-5.0.3-javadoc.jar，文件重命名爲objectify-5.0.3-javadoc.zip

  3. 使用您喜歡的解壓縮工具來提取它，現在你有一個文件夾objectify-5.0.3-javadoc

  4. 雙擊index.html將打開索引頁面在您的默認瀏覽器。

來源

2014-07-07 21:25:04 Max

2

我爲此寫了自己的工具。根據我的同事們的看法，他們最好。

它通過lucene索引一次，並在後臺運行你的小型服務器，所以你喜歡在瀏覽器中瀏覽javadocs（pydocs，perldocs ..）。它也允許單獨的語言庫，所以像「biginteger」或simialr不會出錯的搜索。

https://github.com/judovana/JavadocOfflineSearch/releases

來源

2016-10-06 15:12:57 judovana

相關問題

 相關問題