你怎样阅读JavaDoc文档？

Question

你使用哪些工具或网站来阅读JavaDocs？

我目前在处理J2EE项目时使用Firefox，打开20多个标签页以便获得所有文档，这不太好用，占用过多内存且无法进行搜索。

我期望这样的工具/网站会有以下功能：

• 整合不同位置的JavaDocs
• 像Eclipse中的Ctrl+T一样直接访问类型或类似的功能
• 全文搜索
• 在我选择的所有Java库之间进行交叉引用
• 对于工具：支持离线使用
• 速度快

非强制性要求：

• 注释事项的可能性
• 支持不同版本的库（+差异？）
• IDE集成

编辑： 感谢您的回答，我已经了解了大部分网站，但并不理想。下面是我的评价：

• Eclipse/IDE内置功能
  • 紧密集成
  • 支持在线/离线使用
• javadoconline.com（不再维护）
  • 可以使用
  • 看起来简洁
  • 查找多个API版本的匹配项并允许轻松切换
  • 简单但实用
  • 速度快
• jdocs（离线）
  • 看起来非常复杂
  • 有时会很慢
  • 某些最近版本的库似乎丢失了（Seam 2.0.0，Hibernate Validators），但是看起来您可以自己添加它们
  • IDE集成（未经测试）
  • wiki样式的每个项目的评论
• docjar.com
  • 可以使用
  • 速度快
  • 混乱的用户界面
• javadoc_isearch
  • 适用于 Firefox 的 greasemonkey 脚本，可使浏览 javadocs 更加轻松。
  • 运行流畅，完美无缺。

- jrudolph

---

除了"交叉引用"之外，NetBeans可以完成第一个项目列表中的所有任务（并且早在2008年就已经完成了）。 - user330315

相关：JDK文档链接 - Basil Bourque

Answer 1

JavaDoc jar可以直接解压缩。理论上来说，任何已发布的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 将在默认浏览器中打开索引页。

- Max

Answer 2

如果您使用Eclipse，它能够支持Javadocs。例如，将鼠标悬停在方法调用上会显示一个工具提示，显示该方法的Javadoc。核心Java类的文档已经被默认支持。然而，如果您的项目使用任何其他库（JAR文件），则需要进行一些配置才能将它们的Javadocs插入到Eclipse中。

1. 进入项目属性的“Java Build Path”部分。 2. 转到“Libraries”选项卡，单击JAR文件旁边的“加号”图标。 3. 单击“Javadoc location”，然后单击“Edit...”按钮。

这将让您指定该JAR的Javadocs的位置。它甚至可以让您指定网站URL，因此您不必自己下载Javadocs！

- Michael

---

感谢您对如何做到这一点的准确解释。我知道，但可能还有其他人不知道。 - jrudolph

Answer 3

我为此编写了自己的工具。据我的同事说，这是他们见过的最好的工具。

它使用lucene进行索引一次，并在后台运行一个小型服务器，因此您可以像在浏览器中一样浏览javadocs（pydocs、perldocs等）。它还允许每种语言分别使用库，因此搜索类似于“biginteger”或类似内容时不会出错。 https://github.com/judovana/JavadocOfflineSearch/releases

- judovana

---

刚刚看到这个...很抱歉有点傻，但是当我下载了你的两个jar文件，即JavadocOfflineSearch_2.2.jar和JavadocOfflineSearch.jar后，你能告诉我实际上该怎么做吗？ - mike rodent

你只需要那个版本，它包含了所有的依赖项。我认为那个自述文件已经相当详细了，不是吗？https://github.com/judovana/JavadocOfflineSearch/blob/master/README.md。它在项目的主页上。 - judovana

Answer 4

您可以在此处找到斯坦福大学的JavaDoc文档。

- Léo Léopold Hertz 준영

---

我得到了一个404错误，但是还有这个：http://www.stanford.edu/class/cs108/JavaDocFast.html它提供了一些内置Java类文档的好用快捷链接。 - Tyler

两个链接都失效了。 - MD. Mohiuddin Ahmed

Answer 5

我使用火狐浏览器的 javadoc增量搜索插件。它可以让我轻松地浏览其他库。

- Swati

---

这看起来有点过时了。它还能用吗？ - jrudolph

是的，我测试过了，我真的很喜欢它。它快速且按照预期工作。不错。 - jrudolph

对于Firefox，您可以在地址栏中简单地键入以下内容：jar:file://<path to your zip or jar archive>!/。不要忘记斜杠。来源：http://popqvarnstrom.blogspot.pt/2012/03/browsing-jarzip-files-eg-javadoc-in.html - André

Answer 6

嗯...怎么样：

• http://edu.netbeans.org/quicktour/javadoc.html - NetBeans支持Java文档的Javadoc标准，可以查看和生成。
• http://globaldocs.zeevbelkin.com/ - 这个应用程序允许方便地浏览多个javadoc集合，使用单个包/类层次结构树和可搜索索引，在Internet和本地文件系统上进行。该查看器支持本地和远程docsets（也支持打包到JAR / ZIP文件中的本地docsets）。

我更喜欢NetBeans，因为它可以自动从Maven的~/.m2目录获取JavaDoc...

- gavenkoa

---

有趣，不过我更喜欢一个纯网页解决方案。 - jrudolph

我使用Netbeans，并希望能够在不必将它们附加到库和项目的情况下浏览一般的Javadocs。不幸的是，您关于Netbeans的链接似乎已经过时了。当前的Netbeans（版本7）似乎不支持这种方式。 - Glenn Lawrence

Answer 7

这个针对Firefox和Chrome的插件非常有用，可以快速查找包和类名，虽然它不是全文搜索：https://code.google.com/p/javadoc-search-frame/

- Glenn Lawrence

---

有趣，我不知道这个。谢谢。我没有尝试过，但可能缺少的是API的正确版本控制（因为它只是客户端）。 - jrudolph

Answer 8

Eclipse与Javadoc集成良好，并为其提供了类似HTML的查看器。您可以将源代码和Javadoc附加到二进制文件中，当您选择一个类时，它们会显示出来。

- Heath Borders

Answer 9

这样的东西可能有用吗？

http://www.docjar.com/

- user7094

---

谢谢，是的，我知道这个，但我不喜欢它的搜索功能，也没有导航栏之类的东西。总体来说，设计对我来说不够清晰。 - jrudolph

Answer 10

就我个人而言，使用IDE所提供的内置javadoc浏览工具从未出现过问题。

目前我使用的是IntelliJ Idea——按下Ctrl-Q可以查看光标下方法的javadoc，并且对其他文档部分的超链接也是可用的。

我想NetBeans和Eclipse也提供类似的功能。

- Rob Dickerson

---

确切地说。为什么还要使用其他工具或网站呢？在你大多数需要它们的 IDE 中阅读 Javadocs 是最简便的方法。(获取外部库的 API 文档或源代码的本地副本，以加快访问速度。) - Jonik

@Jonik “为什么要使用额外的工具”：因为并非每个人都在使用它们。例如，使用Python和C++的同事应该可以访问来自Java方面的公共接口文档。-- 其他人可能（并且会）处于与您不同的情况下。 - foo