實在感覺這個 javadoc 太不友好了暴备,這個感覺是給寫這個程序的開發(fā)者看的一種備忘錄,而不是給調用這個方法的人看的說明書岁经。
具體來說地梨,它至少有如下的劣勢:
使用者往往是有需求了才會來讀說明書的,他需要的可能是這種格式:場景毯盈,需求剃毒,怎么用。最好有一點帶code的說明搂赋,然后具體地說這個參數(shù)是什么意思迟赃。
但是現(xiàn)在這種javadoc寫的一串,讀起來佶屈聱牙的文字厂镇,讓人完全看不懂纤壁。javadoc 寫的都是一個個的類,接口什么的那些東西捺信。而調用者往往想知道的是酌媒,你怎么樣建立起這些 抽象體與實體的欠痴。還有最終的就是怎么用,怎么把這些東西組合起來使用秒咨。javadoc有些類根本沒有這東西喇辽。