爲全部導出API 元素編寫文檔註釋（44）

一、JavaDoc 根據特殊的文檔註釋，能夠自動生成api文檔

• 文檔註釋應該簡潔描述出他和客戶端之間的約定
• 說清楚 方法作了什麼，而不是怎麼作的
• 文檔註釋應該列舉出該方法的全部前提條件和後置條件
• 反作用也要描述清楚

前提條件

• @throws 標籤針對未受檢異常所隱含的描述

爲了完整描述方法的約定

• @param  參數
• @return 返回值

@code 註解

@literal 註解

• 生成文檔

同一個類或接口的成員或構造函數不該該有相同的概述

當爲泛型或方法編寫註解時，確保要在註解中說明全部的類型參數

當爲枚舉類型編寫文檔時

• 確保在文檔中說明常量、類型，還有任何公有方法

類導出API的線程安全性和可序列化性

javadoc 具備繼承方法註釋的能力

• 接口的文檔註釋優於超類的文檔註釋