我如何阅读java文档?

Dav*_*vid 15 java

我正在寻找一些关于如何阅读java的各种包类和方法的在线文档的建议.

我的意思是所有这些东西:http://java.sun.com/javase/6/docs/api/

Bal*_*usC 13

这是一个教程.

事实上,只在需要时阅读.对于残余,请阅读教程.通常谷歌搜索"[关键字]教程网站:oracle.com"产生足够的结果.

更新以将以下内容作为您要查找Javadoc的示例:

someString.split("\\.");
Run Code Online (Sandbox Code Playgroud)

someString是一个实例java.lang.String.假设你想从API文档根目录开始(我自己更喜欢在Firefox的地址栏中输入"java.lang.string javase api site:oracle.com"来直接找到它(如果你觉得幸运,并且在浏览器历史记录中没有它,或者只是在我的IDE中检查它),然后在主框架中滚动到java.lang并单击链接,然后在类摘要中检查String并单击链接,然后在方法摘要中检查split()方法并单击链接.

Java SE API的Javadoc简洁,但非常完整,并提供了指向您期望的其他javadoc的链接.例如,在String#split()javadoc 的底部,您会看到类的"另请参见"链接Pattern,这反过来解释了类的介绍中的正则表达式.

  • 然后你需要澄清更多.如果你曾经质疑"java.lang.String#split(String)`究竟做什么?",那么只需转到`java.lang.String`的Javadoc,查找`split()`方法并阅读方法文档.单击您的方法,包,类和方法. (3认同)

cod*_*eim 6

根据需要阅读.就像在项目中一样.文档主要是基于需求的格式,而不是概念教学格式.

否则,如果您想要阅读某些内容以学习SDK,请阅读教学书.

  • 好吧,我想知道当我需要的时候我如何阅读它。 (2认同)

Rus*_*ett 6

将 javadoc 想象成在 iTunes 中浏览专辑。左上角的框架是一个包列表。这就像一个艺术家名单。选择其中之一会更改左下角框架中显示的内容。左下方的框架是在其上方选择的包中的类/接口列表。这就像选择艺术家并显示专辑列表一样。然后您可以选择其中一个类/接口,它的详细视图将出现在主框架中。这就像所选专辑的曲目列表。

撇开 iTunes 的类比不谈,主框架详细信息显示了与该类或接口交互所需的所有公共和受保护信息。在顶部,它显示了继承层次结构和类的描述。下面是类上所有公共或受保护的字段、构造函数和方法的摘要。您可以单击其中任何一个的链接以跳转到完整说明。摘要的底部是所有继承方法的列表。

javadoc 中引用的任何类(例如参数或返回类型)都将是链接。如果单击该链接,它将导航到该类的 javadoc。通过这种方式,可以很容易地浏览所有需要弄清楚发生了什么的类。它并不完全漂亮,但它有效。作为 html,您甚至可以在新选项卡中打开链接,因此可以轻松地一次打开所有相关类。

最后一个提示 - 详细信息窗格顶部有一些额外的选项。我经常使用的一个是 Frames/No Frames 链接。这将添加或删除左侧的包和类框架。如果您在新选项卡中打开其他课程,或者有时如果您使用 google 找到课程,您将看到一个没有额外框架的页面。只需单击 Frames 标签,它们就会被添加到页面中。


Dan*_*iel 5

对我学习 Java SE API 最有帮助的就是“ The Java Tutorials ”。它几乎涵盖了整个 Java SE,其方式比 JavaDoc 更有条理。阅读了您感兴趣的内容后,JavaDocs 本身就会更有意义。

通常我会通过 IDE 阅读 JavaDocs 以获取我感兴趣的内容。我使用 Netbeans,它会自动显示 JavaDoc 作为其代码完成的一部分。这样,我可以部分键入我想要使用的类或方法名称,然后浏览建议的 JavaDoc,直到找到我想要的内容。