Javadoc簡介

Javadoc用於描述類或者方法的作用。Javadoc可以寫在類上面和方法上面。

寫在類上面的Javadoc

寫在類上的文件標註一般分為三段：

第一段：概要描述，通常用一句或者一段話簡要描述該類的作用，以英文句號作為結束。第二段：詳細描述，通常用一段或者多段話來詳細描述該類的作用，一般每段話都以英文句號作為結束。第三段：文件標註，用於標註作者、建立時間、參閱類等資訊。javadoc連結到私有欄位

下面的工作在一個類。

當生成javadoc時，例如透過ant，只需指定包含私有欄位(預設最小訪問許可權是“protected”，而不是“private”)：

總結

Javadoc是我們開發

Javadoc的作用是針對整個方法或者整個類做一個簡要的概述的，使得別人不透過看具體方法程式碼就能知道某個方法或者某個類的作用和功能。