在java開發中，往往需要用到別人寫的類或是自己寫的類被別人拿去用。
而使用類的過程中，類中的方法對使用者而言並不完全透明，這個時候幫助文檔可以讓我們清楚的了解這個類中的方法該如何調用。
下面簡述一下java幫助文檔的制作：
首先，我們在定義一個類時，要在類中相應位置作注釋，這里我們要用到的注釋是這樣的：
/** 注釋內容 */
在注釋內容上一行千萬別少大一個“*”，否則jvm不能對相應內容生成文檔。
之后，說一說注釋中的一些關鍵詞，author->作者，version->版本，param->參數，return->返回值，下面舉個例子：
1 /** 2 這里說明這個類所實現的功能 3 @author 作者名 4 @version 版本號 5 */ 6 7 //注意：要定義為public的類，jvm才不會提示權限不足 8 public class Demo 9 { 10 /** 11 這里說明這個方法的功能 12 @param arr 簡述傳入的參數 13 @return 簡述返回值（無返回值時不寫） 14 */ 15 public int method_1(int[] arr) 16 { 17 //代碼省略 18 } 19 20 //對於私有方法可不寫注釋，由於權限問題，在幫助文檔中不出現 21 private void method_2(int[] arr) 22 { 23 //略 24 } 25 }
最后，我們使用javadoc命令來生成api幫助文檔，下面舉例：
javadoc -d 目錄名 [-author] [-version] 類名 (中括號內可不寫,若要突顯作者和版本號可寫)
比如：javadoc -d helpdoc Demo.java
api幫助文檔制作完成后，你可以在指定目錄下查看index.html文件。
附錄：javadoc命令語法
在命令行輸入javadoc回車就會出現如下的幫助信息：
javadoc用法：javadoc [選項] [軟件包名稱] [源文件] [@file]
-overview <文件> 讀取 HTML 文件的概述文檔
-public 僅顯示公共類和成員 //帶有public修飾符
-protected 顯示受保護/公共類和成員（默認） //帶有protected、public修飾符
-package 顯示軟件包/受保護/公共類和成員 //不帶修飾符，或帶有protected、public修飾符
-private 顯示所有類和成員 //不帶修飾符，或帶有任何修飾符
-help 顯示命令行選項並退出
-doclet <類> 通過替代 doclet 生成輸出
-docletpath <路徑> 指定查找 doclet 類文件的位置
-sourcepath <路徑列表> 指定查找源文件的位置
-classpath <路徑列表> 指定查找用戶類文件的位置
-exclude <軟件包列表> 指定要排除的軟件包的列表
-subpackages <子軟件包列表> 指定要遞歸裝入的子軟件包
-breakiterator 使用 BreakIterator 計算第 1 句
-bootclasspath <路徑列表> 覆蓋引導類加載器所裝入的類文件的位置
-source <版本> 提供與指定版本的源兼容性
-extdirs <目錄列表> 覆蓋安裝的擴展目錄的位置
-verbose 輸出有關 Javadoc 正在執行的操作的消息
-locale <名稱> 要使用的語言環境，例如 en_US 或 en_US_WIN
-encoding <名稱> 源文件編碼名稱
-quiet 不顯示狀態消息
-J<標志> 直接將 <標志> 傳遞給運行時系統
通過標准 doclet 提供:
-d <directory> 輸出文件的目標目錄
-use 創建類和包用法頁面
-version 包含 @version 段
-author 包含 @author 段
-docfilessubdirs 遞歸復制文檔文件子目錄
-splitindex 將索引分為每個字母對應一個文件
-windowtitle <text> 文檔的瀏覽器窗口標題
-doctitle <html-code> 包含概述頁面的標題
-header <html-code> 包含每個頁面的頁眉文本
-footer <html-code> 包含每個頁面的頁腳文本
-top <html-code> 包含每個頁面的頂部文本
-bottom <html-code> 包含每個頁面的底部文本
-link <url> 創建指向位於 <url> 的 javadoc 輸出的鏈接
-linkoffline <url> <url2> 利用位於 <url2> 的包列表鏈接至位於 <url> 的文檔
-excludedocfilessubdir <name1>:..排除具有給定名稱的所有文檔文件子目錄。
-group <name> <p1>:<p2>..在概述頁面中，將指定的包分組
-nocomment 不生成描述和標記，只生成聲明。
-nodeprecated 不包含 @deprecated 信息
-noqualifier <name1>:<name2>:...輸出中不包括指定限定符的列表。
-nosince 不包含 @since 信息
-notimestamp 不包含隱藏時間戳
-nodeprecatedlist 不生成已過時的列表
-notree 不生成類分層結構
-noindex 不生成索引
-nohelp 不生成幫助鏈接
-nonavbar 不生成導航欄
-serialwarn 生成有關 @serial 標記的警告
-tag <name>:<locations>:<header> 指定單個參數自定義標記
-taglet 要注冊的 Taglet 的全限定名稱
-tagletpath Taglet 的路徑
-charset <charset> 用於跨平台查看生成的文檔的字符集。
-helpfile <file> 包含幫助鏈接所鏈接到的文件
-linksource 以 HTML 格式生成源文件
-sourcetab <tab length> 指定源中每個制表符占據的空格數
-keywords 使包、類和成員信息附帶 HTML 元標記
-stylesheetfile <path> 用於更改生成文檔的樣式的文件
-docencoding <name> 輸出編碼名稱