第56條：為所有導(dǎo)出的API元素寫(xiě)文檔注釋养篓。
- 為了正確的編寫(xiě)API文檔够掠，必須在每個(gè)被導(dǎo)出的類(lèi)烂完、接口试疙、構(gòu)造器、方法和域聲明之前增加一個(gè)文檔注釋抠蚣。
- 同一個(gè)類(lèi)或接口中的兩個(gè)成員或者構(gòu)造器祝旷，不應(yīng)該具有相同的概要描述。
- 如果代碼中出現(xiàn)了泛型嘶窄，確保要在文檔中說(shuō)明所有的類(lèi)型參數(shù)怀跛。
- 為枚舉類(lèi)型編寫(xiě)文檔時(shí)，要確保在文檔中說(shuō)明常量柄冲。
- 為注解編寫(xiě)文檔時(shí)吻谋，要說(shuō)明清楚所有成員。
- 類(lèi)或者靜態(tài)方法是否線程安全现横，應(yīng)該在文檔中進(jìn)行聲明漓拾。
這一章作者主要還是站在一個(gè)較高的視角來(lái)考慮問(wèn)題。確實(shí)一般也只在一些封裝好的API中見(jiàn)過(guò)文檔注釋?zhuān)綍r(shí)寫(xiě)代碼一般不會(huì)使用這一套长赞。但是有時(shí)候遇到一些trick難懂的地方晦攒，我也會(huì)寫(xiě)一些注釋來(lái)解釋代碼這樣做的原因闽撤，如果想讓自己的代碼被更多的人使用得哆，文檔注釋這一套還是很有必要的。
