每個(gè)類或成員的Javadoc以一個(gè)簡短的摘要片段開始。這個(gè)片段是非常重要的,在某些情況下,它是唯一出現(xiàn)的文本,比如在類和方法索引中。
這只是一個(gè)小片段,可以是一個(gè)名詞短語或動詞短語,但不是一個(gè)完整的句子。它不會以A {@code Foo} is a...
或This method returns...
開頭, 它也不會是一個(gè)完整的祈使句,如Save the record...
。然而,由于開頭大寫及被加了標(biāo)點(diǎn),它看起來就像是個(gè)完整的句子。
Tip:一個(gè)常見的錯誤是把簡單的Javadoc寫成
/** @return the customer ID */
,這是不正確的。它應(yīng)該寫成/** Returns the customer ID. */
。