Question

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

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

Answer 1

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

更新以下面的示例作为您要查找Javadoc的示例：

someString.split("\\.");

此处someString是java.lang.String的实例。假设你想从API documentation root开始（我自己更喜欢在Firefox的地址栏中输入“java.lang.string javase api site：oracle.com”来直接获取它我（如果你觉得很幸运，并且在浏览器历史记录中没有它），或者只是在我的IDE中检查它，然后在主框架中滚动到java.lang package并单击链接，然后在课程摘要中检查String class并单击链接，然后在方法摘要中选中split() method并单击链接。

Java SE API的Javadoc简洁，但相当完整，并提供了指向您期望的其他javadoc的链接。例如，在String#split() javadoc的底部，您会看到Pattern类的“另请参见”链接，该类反过来解释了该类介绍中的正则表达式内容。

Answer 2

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

否则，如果您想要实际阅读某些东西来学习SDK，请阅读教学书。

Answer 3

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

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

javadoc中引用的任何类（如参数或返回类型）都将是链接。如果单击该链接，它将导航到该类的javadoc。通过这种方式，可以很容易地浏览所需的所有类，以找出正在发生的事情。它不是很漂亮，但它的工作原理。作为html，您甚至可以在新标签页中打开链接，因此可以轻松地一次性打开所有相关课程。

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

Answer 4

JavaDoc仅仅是一个参考。回答“这个（类/方法）做什么？”这个形式的问题是很好的。但对于其他任何事情都很可怕。

如果您对JavaDoc感到困惑，您应该选择一本书或找一个在线教程。使用文档作为参考仅回答特定问题，也许您不会感到困惑。

Answer 5

想象一下，你有一个String，并且你正试图找出如何将它转换为大写。在http://java.sun.com/javase/6/docs/api/java/lang/String.html查看字符串的javadoc （或者从上面的链接中，向下滚动以查找左下方列表中的字符串。

你会发现有一种名为toUpperCase()的方法。您可以单击它以查找详细信息。你会看到那里的所有其他方法，它们描述了你可以对字符串“做”的各种事情。

还有一个构造函数列表，它们告诉你如何“创建”一个字符串对象。

对于String来说可能不是太难，所以尝试更复杂的东西：如何创建BufferedOutputStream？

Answer 6

对我来说，学习Java SE API最有用的事情就是“The Java Tutorials”。它几乎涵盖了整个Java SE，其组织方式比JavaDocs更有条理。在您阅读了您感兴趣的位之后，JavaDocs将更有意义。

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

Answer 7

我是以上所有困惑的用户。至于我自己来自使用Windows API for VB classic的狂热背景，Java API并不具有启发性。

是的，Java API提供了大量有关自身的信息，每个类的功能以及它的结构;但是，对于在开发过程中有用的东西，它几乎可以阻止而不是引用解决方案和可用的代码。

考虑到任何刚接触Java的人都几乎无法回想起或记住每个包中的哪些功能。然后找到一个方法，函数，类或已定义的术语使用是一场噩梦。

关于Java的API文档：它与环境和语言有所不同，特别具体;它是一个完全不同的球类游戏，当它更专注于简单地与众不同，尽管对初学者来说是不连贯的。眼睛。

我相信人们会发现，通过对Java杂乱无章的API文档布局的重大改进，大大简化了开始编码的步骤。

我如何阅读java文档？

7 个答案: