java - 你如何阅读 JavaDoc?

标签 java documentation javadoc

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

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

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

  • 聚合来自不同位置的 JavaDocs
  • 直接访问 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 脚本,使浏览javadocs 更容易
    • 运行顺畅且完美

最佳答案

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

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

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

关于java - 你如何阅读 JavaDoc?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/73366/

相关文章:

documentation - 最好地使用 Google 代码 wiki 来获取项目文档

java - 如何快速创建指向 Eclipse 中元素的 Javadoc 链接?

java - Tomcat + ActiveJDBC : open/close connection using servlet filter?

java - 当该部分文本发生更改时,从“可编辑”中删除跨度

java - 将多个参数作为一个 http 查询参数传递的最佳方法是什么?

kotlin - Kotlin 文档中未解析的 @sample

javascript - 使用 $resource 发送音频数据 (base64)

php - 记录 PHP 代码 - 记录一组包含或要求的最佳方式

java - 需要帮助将特定供应商的 Javadoc 集成到 Eclipse

带有 Maven 的 Java 11/12 Javadoc 导致不为测试生成 Javadoc