你怎么读JavaDoc？

Question

您使用哪些工具/网站来阅读JavaDocs？

我目前使用的Firefox在开放J2EE项目时打开了20多个标签，以获得所有可用的文档，这些文档不太可用，占用的内存太多而且无法搜索。

我对这样的工具/网站的期望是什么：

• 从不同位置聚合JavaDoc
• 直接访问Eclipse中类似Ctrl + T的类型或类似的
• 全文搜索
• 我选择的所有Java库之间的交叉引用
• 对于工具：离线支持
• 速度

不是强制性的：

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

编辑：

感谢您的回答。我知道大多数网站，但又给了他们一次尝试。这是我的判断：

• 内置Eclipse / IDE功能
  • 紧密整合
  • 离线/在线支持
• javadoconline.com（不再维护）
  • 工作原理
  • 干净的外表
  • 在api的多个版本中查找匹配项并允许轻松切换
  • 简单但有效
  • 快
• jdocs（离线）
  • 似乎非常复杂
  • 有时候很慢
  • 似乎缺少一些最新版本的库（Seam 2.0.0，Hibernate Validators），但看起来你可以自己添加它们
  • IDE集成（未测试）
  • 对每个项目的维基风格评论
• docjar.com
  • 工作原理
  • 快
  • 杂乱的用户界面
• javadoc_isearch
  • firefox的firemonkey脚本，可以更轻松地导航javadoc
  • 工作顺利，完美

Answer 1

如果您使用Eclipse，它会为Javadoc提供支持。例如，将鼠标悬停在方法调用上将显示一个工具提示，显示该方法的Javadoc。开箱即用支持核心Java类的文档。但是，如果您的项目使用任何其他库（JAR文件），则需要进行一些配置才能将其Javadoc插入Eclipse。

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

这将允许您指定该JAR的Javadoc所在的位置。它甚至可以让你指定一个网站URL，所以你不必自己下载Javadoc！

Answer 2

我使用http://www.teria.com/~koseki/tools/gm/javadoc_isearch/作为FF。让我轻松浏览其他库。

Answer 3

您可以找到斯坦福大学的JavaDoc here。

Answer 4

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将打开默认浏览器上的索引页面。

Answer 5

我为此编写了自己的工具。根据我的同事，他们最好看到。

它通过lucene索引一次，并在后台运行你的小服务器，所以你在浏览器中浏览javadocs（pydocs，perldocs ..）。它还允许每种语言使用单独的库，因此搜索类似于＆＃34; biginteger＆＃34;或者类似的不要出错。

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

Answer 6

Eclipse与Javadoc很好地集成，并且有一个类似HTML的查看器。您可以将source和javadoc附加到选择类时将显示的二进制文件。

Answer 7

这样的东西可能有用吗？

http://www.docjar.com/

Answer 8

就个人而言，我从来没有遇到过我的IDE提供的内置javadoc浏览工具的问题。

目前，我使用IntelliJ Idea - Ctl-Q为光标下的方法调用javadoc，并带有指向文档其他部分功能的超链接。

我认为NetBeans和Eclipse提供类似的功能。

Answer 9

嗯......怎么样：

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

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

Answer 10

此插件适用于Firefox和Chrome，可用于快速查找包名和类名，但不是全文搜索：https://code.google.com/p/javadoc-search-frame/

Answer 11

Doxygen（http://www.doxygen.nl/）可能符合要求。

编辑：我可能误解了你的问题，doxygen是一个基于你的代码和javadoc生成文档和模型的工具。

Answer 12

Eclipse是查看javadoc的最佳方式。将鼠标悬停在方法或任何声明上，您将通过eclipse自动生成javadocs。