32

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

我目前使用 Firefox，在处理 J2EE 项目时打开了 20 多个选项卡，以获取所有可用的文档，这些文档不是很有用，占用了太多内存并且不可搜索。

我对这样一个工具/网站的期望：

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

不是强制性的：

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

编辑：

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

  • 内置 Eclipse/IDE 功能
    • 紧密集成
    • 离线/在线支持
  • javadoconline.com（不再维护）
    • 作品
    • 干净的外观
    • 在多个版本的 api 中查找匹配项并允许轻松切换
    • 简单但有效
    • 快速地
  • jdocs（离线）
    • 看起来很精致
    • 有时很慢
    • 似乎缺少一些最新版本的库（Seam 2.0.0，Hibernate Validators），但看起来您可以自己添加它们
    • IDE 集成（未测试）
    • 每个项目的wiki风格评论
  • docjar.com
    • 作品
    • 快速地
    • 混乱的用户界面
  • javadoc_isearch
    • Firefox的greasemonkey脚本，使浏览javadocs更容易
    • 工作顺利，完美
4

12 回答 12

9

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

  1. 转到项目属性的“Java 构建路径”部分。
  2. 转到“库”选项卡并单击 JAR 文件旁边的“加号”图标。
  3. 单击“Javadoc 位置”，然后单击“编辑...”按钮。

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

于 2008-09-16T20:10:26.647 回答
8

JavaDoc jar 可以直接解压。理论上，任何发布的 javadocs 都可以离线下载和查看。

  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-07T21:25:04.510 回答
4

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

于 2009-04-25T19:49:11.490 回答
3

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

它按 lucene 索引一次，并在后台运行您的小型服务器，因此您可以像在浏览器中一样浏览 javadocs（pydocs、perldocs..）。它还允许每种语言单独的库，因此像“biginteger”或 simialr 这样的搜索不会出错。

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

于 2016-10-06T15:12:57.643 回答
2

我将http://www.teria.com/~koseki/tools/gm/javadoc_isearch/用于 FF。让我也可以轻松浏览其他库。

于 2008-09-16T15:16:44.827 回答
1

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

于 2008-09-16T15:10:59.583 回答
1

像这样的东西可能有用吗？

http://www.docjar.com/

于 2008-09-16T15:13:01.823 回答
1

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

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

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

于 2008-09-16T15:15:43.503 回答
1

这个用于 Firefox 和 Chrome 的插件对于快速查找包和类名很有用，尽管它不是全文搜索：https ://code.google.com/p/javadoc-search-frame/

于 2013-11-08T00:15:54.840 回答
1

嗯...怎么样：

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

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

于 2013-02-18T13:19:39.113 回答
0

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

于 2013-04-19T03:23:57.707 回答
0

Doxygen ( http://www.doxygen.nl/ ) 可能符合要求。

编辑：我可能误读了您的问题，doxygen 是一种根据您的代码和 javadoc 生成文档和模型的工具。

于 2008-09-16T15:11:47.910 回答