你怎么读JavaDoc?

jru*_*lph 31 java documentation javadoc

您使用哪些工具/网站来阅读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的greasemonkey脚本,使导航javadoc更容易
    • 工作顺利,完美

Mic*_*ael 9

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

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

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


Max*_*Max 7

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


Hea*_*ers 1

Eclipse 与 Javadoc 集成良好,并具有类似 HTML 的查看器。您可以将源代码和 javadoc 附加到选择类时将显示的二进制文件。