如何阅读java文档？

我想了解一些关于如何阅读java各种包、类和方法的在线文档的建议

我指的是所有这些东西：

根据需要阅读。例如，在项目的上下文中。文档主要是基于需求的格式，而不是概念教学格式

---

否则，如果你真的想读一些东西来学习SDK，比如，读一本教学书。

JavaDoc仅仅是一本参考书。这对于回答“这个（类/方法）做了什么？”这样的问题很好，但对于其他任何事情都很糟糕

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

事实上，只有在需要的时候才读。对于剩余部分，请阅读教程。通常谷歌搜索“[关键词]教程网站：oracle.com”会得到足够的结果

更新以下面的示例为例，您希望找到Javadoc：

someString.split("\\.");

这里的

someString

是

java.lang.String

的一个实例。假设您想从（我自己更喜欢在Firefox的地址栏中键入“java.lang.string javase api site:oracle.com”直接启动（如果您感到幸运，并且在浏览器历史记录中还没有），或者只在我的IDE中检查），然后在主框架中滚动到并单击链接，然后在类摘要中选中并单击链接，然后在方法摘要中选中并单击链接

---

JavaSEAPI的Javadoc很简洁，但相当完整，并提供了指向其他Javadoc的链接。例如，在

String#split（）

javadoc的底部，您会看到一个指向该类的“see也”链接，这反过来解释了该类简介中的regex内容。

假设您有一个字符串，并且您正在尝试解决如何将其转换为大写。查看javadoc中的字符串，在 （或者从上面的链接，只需向下滚动以在左下角列表中查找字符串

你会发现那里有一个名为

toUpperCase（）

的方法。你可以点击它来查找详细信息。你会在那里看到所有其他方法，它们描述了你可以对字符串“做”的事情

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

---

也许这对字符串来说不太难，所以试试更复杂的方法：如何创建BufferedOutputStream？

将javadoc想象成在itunes中浏览相册。左上角的框架是一个软件包列表。这就像艺术家列表。选择其中一个会改变左下角框架中显示的内容。左下角的框架是一个C语言列表在上面选择的包中的类/接口。这就像选择艺术家并显示相册列表。然后，您可以选择一个类/接口，其详细视图将显示在主框架中。这就像所选相册的曲目列表

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

javadoc中引用的任何类（如参数或返回类型）都将是链接。如果单击该链接，它将导航到该类的javadoc。通过这种方式，可以很容易地导航到所有需要的类，以了解发生了什么。它并不完全漂亮，但可以工作。作为html，您甚至可以打开链接在一个新的选项卡中，可以轻松地同时打开所有相关的类

---

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

对我学习Java SE API最有帮助的事情是去做”。它几乎涵盖了整个Java SE，比Java文档更有条理。 在您阅读了感兴趣的部分之后，Javadoc将自己变得更有意义

---

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

我不想让用户感到困惑。至于我自己，我来自一个狂热的使用VB经典版Windows API的背景，Java API并不具有启发性

是的，javaapi提供了关于它自己、每个类的功能以及它的结构的大量信息；但是，对于开发过程中有用的任何东西，它都非常不推荐，而不是引用解决方案和可用代码

假设任何一个Java新手都很难回忆或记忆每个包中的函数，那么找到一个方法、函数、类或已经定义的术语是一场噩梦

关于Java的API文档：这是一件不同的事情，对环境和语言来说是非常特殊的；这是一个完全不同的游戏，它更关注于简单的不同，尽管对初学者来说是不连贯的

我相信人们会发现，通过对Java混乱的