java之javadoc命令

標籤：

【javadoc命令的用法】
1.java源檔案裡，注釋以/**開始 並以*/結束，裡面可以包含普通檔案，HTML標記和javaDoc標記。這些將構成javaDoc文檔。
2.javadoc命令只能處理java源檔案中在類聲明，介面聲明，成員方法聲明，成員變數聲明及構造方法聲明之前的注釋，忽略位於其它地方的注釋。如 局部變數前的注釋，即使符合規範也會被javadoc命令忽略。
3.常見的javadoc標記
@version 指定版本資訊
@since 指定最早出現在那個版本
@author 指定作者
@see 產生參考其它javaDoc文檔的連結
@link 產生參考其它javadoc文檔的連結，它和@see標記的區別在於@link標記能夠嵌入到備註陳述式中，為備註陳述式中的特定詞彙產生連結。
@deprecated 用來標明被注釋的類，變數或方法已經不提倡使用，在將來的版本中可能被廢棄。
@param 描述方法的參數
@return 描述方法的傳回值
@throws 描述方法拋出的異常，指明拋出異常的條件
4.javadoc命令既可以處理包，也可以處理java源檔案.
javadoc [option] [packagenames] [sourcefiles]
javadoc命令的主要選項:
-public 僅為public存取層級的類及類的成員產生javaDoc文檔
-proteceted 僅為public和protected存取層級的類及類的成員產生javadoc文檔.
(預設選項)
-package 僅為public,protected和預設存取層級的類及類的成員產生
javaDoc文檔
-private 為public,protected,預設和private存取層級的類及類的成員產生javadoc文檔
-version 解析@version標記
-author 解析@author標記
-splitindex 將索引分為每個字母對應一個索引檔案
-sourcepath <pathlist> 指定java源檔案的路徑
-classpath <pathlist> 指定classpath
-d <directory> 指定javaDoc文檔的輸出目錄
javadoc命令的幾個選項的用法:
-public,-protected,-package和-private這4個選項用於指定輸出那些存取層級的類和成員的javaDoc文檔.其中protected為預設選項。
-version和-author選項指定在javaDoc文檔中包含由@version和@author標記指示的內容。這兩個選項不是預設選項。在預設情況下，javadoc命令會忽略注釋中的@version和@author標記，因此產生的javaDoc文檔中不包含版本和作者資訊。

java之javadoc命令