java - 在哪里可以找到有关 Oracle Java 文档中使用的约定的信息？

Question

已结束。此问题正在寻求书籍、工具、软件库等的推荐。不满足 Stack Overflow guidelines 。目前不接受答案。

---

我们不允许提出寻求书籍、工具、软件库等推荐的问题。您可以编辑问题，以便用事实和引文来回答。

已关闭 5 年前。

Improve this question

我对 Java 比较陌生，在阅读 Java 文档时仍然会遇到以前从未见过的方法。有时我对使用这些方法的正确方法感到困惑，因为我不知道 Oracle 使用的约定。

考虑 String class page 中的这个示例:

contains(CharSequence s) 
Returns true if and only if this string contains the specified sequence of char values.

我想知道:

是CharSequence字面值？是否代表变量s必须是CharSequence ？使用此方法的正确语法是什么？

虽然在进一步挖掘后得到澄清，但我觉得如果我知道某种元文档，我可以大大缩小搜索范围。如果某个地方有一个文档说“我们总是在示例中使用代表性数据”，或者“文字总是粗体”或“您假定已经定义的变量总是斜体”，那就太好了。

例如，在上面的示例中，为了清楚起见，我会这样表述:

contains(s) 
where s is a user-defined variable of type CharSequence 
Returns true if and only if this string contains the specified sequence of char values.

我未能成功找到任何记录该文档的内容，并且我的大多数搜索都返回有关 JavaDoc 的结果。如果有人知道的话，我希望有一个链接。

Answer 1

“字面值”是什么意思？它(CharSequence)是名为s的参数的类型。

语法是在字符串实例上调用contains。您传入一个 CharSequence(例如，一个 String)，然后返回一个 boolean 值，指示您调用它的实例是否包含传入的值:

String s = "foobar";
System.out.println(s.contains("ooba")); // true
System.out.println(s.contains("ohai")); // false

这与不理解Javadocs无关，这不是理解Java。

但是，在这种情况下，我不确定困惑所在。假设您知道 Java 是 OOPL，并且除了原语之外，您还调用实例上的方法(现在忽略静态方法)，那么问题是什么？ String API 显示字符串是一个 CharSequence，即此方法采用的类型。措辞描述了该方法的作用。测试代码似乎是不言而喻的——但我是一个有偏见的样本;)

由于从文档的角度来看它相当清楚，我不得不假设这是一个理解 Java 基本性质的问题。而且您总是会遇到以前从未见过的方法。还有类(class)。还有包裹。还有图书馆。仅 JDK 中就有数千个方法，更不用说 Java EE 了，更不用说任何规模的任何 Java 应用程序中使用的数百个其他库了。

简单的例子；一个非常小的工作项目有 120 多个依赖项。在这 120 多个依赖项中有 2500 多个类。在这 2500 多个类中，有大约 16k 个公共(public)属性(字段、方法、静态值)。这不包括 Java SE 和 Java EE API。

我猜我已经见过或使用过千分之一的项目特定 API。