關於如何生成Java文檔

一.生成Java文檔，要明白Java註釋內容，若是不知道，能夠去看上一篇文章。

二.Java系統提供的javadoc工具能夠根據程序結構自動生成註釋文檔。當程序修改時可方便及時更新生成的註釋文檔。javadoc.exe工具存在於JDK的bin目錄下，使用javadoc將讀取.java源文件中的文檔註釋，並按照必定的規則與Java源程序一塊兒進行編譯，生成文檔。

三.javadoc經常使用標記：

（上面截圖來自javadoc的百度百科，讀者也能夠本身去百度百科看），除了這些，還有一些不經常使用的標記，這裏就不列舉了。

四.javadoc命令的通常形式：

javadoc [options] [packages] [sourcefiles] [@files]

在命令中有4組可選項，方括號自己不是命令的一部分。命令行的每一個選項之間用一個或多個空格分開。各組選項的用途：

①options，指定執行javadoc時的命令選項，若是想顯示標準命令選項，可使用以下命令：javadoc -help

②packages，須要處理的一系列包名，名字之間用一個或多個空格分開

③sourcefiles，一系列用空格分隔的源文件名，可使用通配符，若是想指定當前目錄的全部源文件，可使用*.java表示

④@files，用空格分隔的一個或多個源文件的名字，也能夠是一個或多個包，每一個文件必須用@作爲前綴符

五.Javadoc中options選項不少，下面列出了經常使用的選項：

①-author，生成@author標記

②-version，生成@version標記

③-package，把文檔輸出到包、公有的或受保護的類和成員上

④-public，把文檔輸出到公有類和成員上

⑤-protected，把文檔輸出到公有類和受保護的類以及公有的類成員上

⑥-private，把全部類和成員生成文檔註釋

⑦-d directoryName，使javadoc生成的HTML文件存儲在指定的目錄下。默認爲當前目錄

六.示例

Java代碼：

 

注意：

①這個類必定要使用public修飾，這表示對外開放的，這樣javadoc才能從中提取出註釋文檔；

②類中的方法（包括構造）若是使用private修飾，即本類中的內部調用類，則在生成的註釋文檔中不會顯示這個方法，由於private表明它不對外開放。

在命令提示符下操做（先進入源程序目錄）：

①javadoc -d myhelp -author -version ArrayTool.java

（這裏myhelp是指生成的幫助文檔將放在源目錄的myhelp子目錄下面，這個目錄也能夠本身設置，只要是完整的路徑就能夠，若是寫了本地磁盤上沒有的文件夾，則myhelp文件夾將自動生成）