摘要片段

每个Javadoc块都以一个简短的摘要片段开始。这个片段非常重要:它是在某些上下文中出现的唯一部分,如类和方法索引。

这应该是一个片段—————一个名词短语或动词短语,而不是一个完整的句子。它不是以 A {@code Foo} is a...This method returns... 开头的,也不形成像 Save the record. 这样的完整祈使句。然而,这个片段就像是一个完整的句子一样需要首字母大写和相应的标点符号。

Tip

提示: 一个常见的错误是以这种形式编写简单的Javadoc: /** @return the customer ID */ 。这是不正确的,应该改为 /** Returns the customer ID. */