我对 Java 比较陌生,并且在阅读 Java 文档时仍然会遇到以前从未见过的方法。我有时对使用这些方法的正确方式感到困惑,因为我不知道 Oracle 使用的约定。
考虑String 类页面中的这个例子:
contains(CharSequence s)
Returns true if and only if this string contains the specified sequence of char values.
我想知道:
是CharSequence
字面值吗?它是否表示变量s
必须是 a 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 的结果。如果有人知道,我会喜欢一个链接。