第56條：為所有導(dǎo)出的API元素寫文檔注釋。
- 為了正確的編寫API文檔，必須在每個(gè)被導(dǎo)出的類、接口、構(gòu)造器、方法和域聲明之前增加一個(gè)文檔注釋。
- 同一個(gè)類或接口中的兩個(gè)成員或者構(gòu)造器，不應(yīng)該具有相同的概要描述。
- 如果代碼中出現(xiàn)了泛型，確保要在文檔中說明所有的類型參數(shù)。
- 為枚舉類型編寫文檔時(shí)，要確保在文檔中說明常量。
- 為注解編寫文檔時(shí)，要說明清楚所有成員。
- 類或者靜態(tài)方法是否線程安全，應(yīng)該在文檔中進(jìn)行聲明。
這一章作者主要還是站在一個(gè)較高的視角來考慮問題。確實(shí)一般也只在一些封裝好的API中見過文檔注釋，平時(shí)寫代碼一般不會(huì)使用這一套。但是有時(shí)候遇到一些trick難懂的地方，我也會(huì)寫一些注釋來解釋代碼這樣做的原因，如果想讓自己的代碼被更多的人使用，文檔注釋這一套還是很有必要的。
