對(duì)于簡(jiǎn)單明顯的方法如getFoo
,Javadoc是可選的(即,是可以不寫的)。這種情況下除了寫“Returns the foo”,確實(shí)也沒有什么值得寫了。
單元測(cè)試類中的測(cè)試方法可能是不言自明的最常見例子了,我們通常可以從這些方法的描述性命名中知道它是干什么的,因此不需要額外的文檔說明。
Tip:如果有一些相關(guān)信息是需要讀者了解的,那么以上的例外不應(yīng)作為忽視這些信息的理由。例如,對(duì)于方法名
getCanonicalName
, 就不應(yīng)該忽視文檔說明,因?yàn)樽x者很可能不知道詞語canonical name
指的是什么。