我们如何阅读JavaDoc?
我们使用什么工具/网站来阅读JavaDoc?
我目前在使用J2EE项目时使用Firefox,并且打开了20多个选项卡,以使所有可用的文档不怎么可用,占用太多内存并且无法搜索。
我希望从这样的工具/网站获得什么:
- 聚集来自不同位置的JavaDocs
- 直接访问Eclipse中的Ctrl + T之类的类型或者类似内容
- 全文搜索
- 我选择的所有Java库之间的交叉引用
- 对于工具:离线支持
- 速度
不是强制性的:
- 注释事物的可能性
- 支持库的不同版本(+ diff?)
- IDE整合
编辑:
感谢回答。我知道大多数站点,但是又给了他们一次尝试。这是我的判断:
- 离线/在线支持
- 干净的外观
- 在多个版本的api中找到匹配项,并允许轻松切换
- 简单但可行
- 快速地
- 有时慢
- 似乎缺少了一些最新版本的库(Seam 2.0.0,Hibernate Validators),但是我们似乎可以自己添加它们
- IDE集成(未经测试)
- Wiki风格对每个项目的评论
- 快速地
- 混乱的用户界面
- 流畅完美地工作
解决方案
回答
Eclipse与Javadoc集成良好,并且具有类似HTML的查看器。我们可以将源代码和javadoc添加到在选择类时显示的二进制文件。
回答
Doxygen(http://www.stack.nl/~dimitri/doxygen/)可能适合我们。
编辑:我可能误解了问题,doxygen是基于代码和javadoc生成文档和模型的工具。
回答
这样的事情可能有用吗?
http://www.docjar.com/
回答
就个人而言,我从未遇到过IDE提供的内置javadoc浏览工具的问题。
当前,我使用IntelliJ Idea -Ctl-Q调出光标下方法的javadoc,并带有指向文档功能其他部分的超链接。
我可以想象NetBeans和Eclipse提供类似的功能。
回答
我对FF使用http://www.teria.com/~koseki/tools/gm/javadoc_isearch/。也让我轻松浏览其他库。
回答
如果使用Eclipse,它将提供对Javadocs的支持。例如,将鼠标悬停在方法调用上将显示一个工具提示,向我们显示该方法的Javadoc。开箱即用地支持核心Java类的文档。但是,如果项目使用任何其他库(JAR文件),则需要进行一些配置才能将其Javadocs插入Eclipse。
- 转到项目属性的" Java构建路径"部分。
- 转到"库"选项卡,然后单击JAR文件旁边的"加号"图标。
- 单击" Javadoc位置",然后单击"编辑..."按钮。
这将允许我们指定该JAR的Javadocs的位置。它甚至可以让我们指定网站URL,因此我们不必自己下载Javadocs!
回答
我们可以在此处找到斯坦福大学的JavaDoc。