你如何阅读JavaDoc?[已关闭]

2022-09-01 09:59:19

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

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

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

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

非强制性:

  • 注释事物的可能性
  • 支持不同版本的库(+比较?
  • 集成

编辑:

感谢您的回答。我知道大多数网站,但又试了一次。这是我的判断:

  • 内置的 Eclipse/IDE 功能
    • 紧密集成
    • 离线/在线支持
  • javadoconline.com(不再维护)
    • 工程
    • 干净的外观
    • 在多个版本的 API 中查找匹配项,并允许轻松切换
    • 简单但工作
  • jdocs (offline)
    • 看起来很复杂
    • 有时速度很慢
    • 一些最新版本的库似乎丢失了(Seam 2.0.0,Hibernate Validators),但看起来你可以自己添加它们
    • IDE 集成(未测试)
    • 对每个项目的 wiki 样式注释
  • docjar.com
    • 工程
    • 杂乱的用户界面
  • javadoc_isearch
    • firefox 的 greasemonkey 脚本,它使 javadocs 的导航更容易
    • 工作流畅而完美

答案 1

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

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

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


答案 2

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.jarobjectify-5.0.3-javadoc.zip

  3. 使用您喜欢的解压缩工具提取它,现在您有一个文件夹objectify-5.0.3-javadoc

  4. 双击将在默认浏览器上打开索引页。index.html


推荐