Javadoc生成方法1：在eclipse中生成

在項目列表中按右鍵，選擇Export（導(dǎo)出），然后在Export(導(dǎo)出)對話框中選擇Java下的Javadoc，提交到下一步。
在Javadoc Generation對話框中有兩個地方要注意的：
Javadoc command：應(yīng)該選擇jdk的bin/Javadoc.exe
destination：為生成文檔的保存路徑，可自由選擇。
按finish(完成)提交即可開始生成文檔。

Javadoc生成方法2：命令行方式生成

Javadoc的命令行語法如下：

Javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]
參數(shù)可以按照任意順序排列。下面分別就這些參數(shù)和相關(guān)的一些內(nèi)容進行說明：
• Packagenames 包列表。這個選項可以是一系列的包名（用空格隔開），例如Java.lang Java.lang.reflect Java.awt。不過，因為Javadoc不遞歸作用于子包，不允許對包名使用通配符；所以你必須顯示地列出希望建立文檔的每一個包。
• Sourcefiles 源文件列表。這個選項可以是一系列的源文件名（用空格隔開），可以使用通配符。Javadoc允許四種源文件：類源代碼文件、包描述文件、總體概述文件、其他雜文件。
◇ 類源代碼文件：類或者接口的源代碼文件。
◇ 包描述文件：每一個包都可以有自己的包描述文件。包描述文件的名稱必須是"package.html"，與包的.Java文件放置在一起。包描述文件的內(nèi)容通常是使用HTML標(biāo)記寫的文檔。Javadoc執(zhí)行時將自動尋找包描述文件。如果找到，Javadoc將首先對描述文件中 之間的內(nèi)容進行處理，然后把處理結(jié)果放到該包的Package Summary頁面中，最后把包描述文件的第一句（緊靠）放到輸出的Overview summary頁面中，并在語句前面加上該包的包名。
◇ 總體概述文件：Javadoc可以創(chuàng)建一個總體概述文件描述整個應(yīng)用或者所有包?？傮w概述文件可以被任意命名，也可以放置到任意位置。-overview 選項可以指示總體概述文件的路徑和名稱?？傮w概述文件的內(nèi)容是使用HTML標(biāo)記寫的文檔。Javadoc在執(zhí)行的時候，如果發(fā)現(xiàn)-overview選項，那么它將首先對文件中之間的內(nèi)容進行處理；然后把處理后的結(jié)果放到輸出的Overview summary 頁面的底部；最后把總體概述文件中的第一句放到輸出的Overview summary頁面的頂部。
◇ 其他雜文件：這些文件通常是指與Javadoc輸出的HTML文件相關(guān)的一些圖片文件、Java源代碼文件（.Java）、Java程序（.class）、Java小程序（Applets）、HTML文件。這些文件必須放在doc-files目錄中。每一個包都可以有自己的doc- files目錄。舉個例子，你希望在Java.awt.Button的HTML文檔中使用一幅按鈕的圖片（Button.gif）。首先，你必須把圖片文件放到C：usersrcJavaawtdoc-files中；然后在Button.Java文件中加入下面注釋

/**  
* This button looks like this：   
*   
*/ 

• @files 包含文件。為了簡化Javadoc命令，你可以把需要建立文檔的文件名和包名放在一個或多個文本文件中。例如，為了簡化下面命令：
Javadoc -d apidoc com.mypackage1 com.mypackage2 com.mypackage3
你可以建立一個名稱為mypackage.txt的文件，其內(nèi)容如下：

com.mypackage1  
com.mypackage2  
com.mypackage3 

然后執(zhí)行下面命令即可：
Javadoc -d apidoc @mypackage.txt
• options 命令行選項。Javadoc使用doclets（doclets是指用doclet API編寫的程序。）來確定輸出的內(nèi)容和格式。命令行選項中一部分是可用于所有doclet的通用選項，一部分是由默認(rèn)的標(biāo)準(zhǔn)doclet提供的專用的選項。下面對各自一些常用的選項分別進行介紹：
通用選項：
◇ -1.1 生成具有Javadoc 1.1版本生成的文檔的外觀和功能的文檔。不是所有的選項都可以用于-1.1選項，具體可以使用Javadoc -1.1 -help察看。
◇ -help 顯示聯(lián)機幫助。
◇ -bootclasspath classpathlist 指定"根類"（通常是Java平臺自帶的一些類。例如Java.awt.*等）的路徑。
◇ -sourcepath sourcepathlist 指定包的源文件搜索路徑。但是必須注意，只有在Javadoc命令中指定了包名的時候才可以使用-sourcepath選項。如果指定了包名，而省略了- sourcepath，那么Javadoc使用類路徑查找源文件。舉例說明：假定你打算為com.mypackage建立文檔，其源文件的位置是C： usersrc。那么你可以使用下面的命令：
Javadoc -sourcepath c：usersrc com.mypackage
◇ -classpath classpathlist 指定Javadoc查找"引用類"的路徑。引用類是指帶文檔的類加上它們引用的任何類。Javadoc將搜索指定路徑的所有子目錄。 Classpathlist可以包含多個路徑（使用;隔開）。如果省略-classpath，則Javadoc使用-sourcepath查找源文件和類文件。舉例說明：假定你打算為com.mypackage建立文檔，其源文件的位置是C：usersrc，包依賴C：userlib中的庫。那么你可以使用下面的命令：
Javadoc -classpath c：userlib -sourcepath c：usersrc com.mypackage
◇ -overview pathfilename 告訴Javadoc從pathfilename所指定的文件中獲取概述文檔，并且把它放到輸出的概述頁面（overview-summary.html）中。其中pathfilename是相對于-sourcepath的相對路徑。
◇ -public 只顯示公共類以及成員。
◇ -protected 只顯示受保護的和公共的類以及成員。缺省選項。
◇ -package只顯示包、受保護的和公共的類以及成員。
◇ -private 顯示所有類和成員。
◇ -doclet class 指定Javadoc產(chǎn)生輸出內(nèi)容的自定義doclet類。如果忽略這個選項，Javadoc將使用默認(rèn)的doclet產(chǎn)生一系列HTML文檔。
◇ -docletpath classpathlist 與- doclet選項相關(guān)，制定自定義的doclet類文件的路徑。Classpathlist可以包含多條路徑（用;隔開）。
◇ -verbose 在Javadoc運行時提供更詳細(xì)的信息。
標(biāo)準(zhǔn)doclet專用選項：
◇ -author 在生成的文檔中包含"作者"項。
◇ - d directory 指定Javadoc保存生成的HTML文件的目錄。省略該選項將把文件保存在當(dāng)前目錄。Directory可以是絕對目錄，也可以是相對當(dāng)前目錄的相對目錄。
◇ -version 在生成的文檔中包含"版本"項。
◇ -use 為類和包生成"use"（用法）頁面。這些頁面描述了該類和包在Javadoc命令涉及的文件中被使用的情況。例如：對于給定的類C，在C的用法頁面中將包含C的子類，類型為C的域，返回變量類型為C的方法以及在參數(shù)中有變量類型為C的方法和構(gòu)造器。
◇ -splitindex 把索引文件按照字母順序分為多個文件。每一個文件對應(yīng)一個字母。
◇ -windowtitle title 指定輸出的HTML文檔的標(biāo)題。
◇ -header header 指定輸出的HTML文檔的頁眉文本。
◇ -footer footer 指定輸出的HTML文檔的腳注文本。
◇ -bottom text 指定輸出的HTML文檔底部的文本。
◇ - group groupheading packagepatten;packagepatten;… 在總體概述頁面中按照命令的指定方式分隔各個包。例如執(zhí)行下面命令：
Javadoc -group "Core Packages" "Java.lang*：Java.util"
-group "Extension Packages" "Javax.*"
Java.lang Java.lang.reflect Java.util Javax.servlet Java.new
在頁面中將有如下結(jié)果：

Core Packages   
Java.lang   
Java.lang.reflect   
Java.util   
Extension Packages   
Javax.servlet   
Other Packages   
Java.new  

◇ - noindex 不輸出索引文件。
◇ - help 在文件的導(dǎo)航條中忽略help鏈接。
◇ - helpfile pathfilename 指定導(dǎo)航條中的help鏈接所指向的幫助文件。忽略該選項，Javadoc將生成缺省的幫助文件。
◇ -stylesheetfile pathfilename 指定Javadoc的HTML樣式表文件的路徑。忽略該選項，Javadoc將自動產(chǎn)生一個樣式表文件stylesheet.css。
JavaDoc文檔標(biāo)記
Javadoc注釋以"/**"開始，以"*/"結(jié)束，里面可以包含普通文本、HTML標(biāo)記和Javadoc標(biāo)記。Javadoc只處理源文件中在類/接口定義、方法、域、構(gòu)造器之前的注釋，忽略位于其他地方的注釋。舉例如下：

/**  
*Demo--Helloworld  
*@author sunjl  
*@version 1.0 2001/10/15  
*/ 
public class myHelloworld  
{  
/**  
*在main( )方法中使用的顯示用字符串  
*@see #main(Java.lang.String[])  
*/ 
static String SDisplay;   
/**  
*顯示HelloWorld  
*@param args 從命令行中帶入的字符串  
*@return 無  
*/ 
public static void main(String args[])  
{  
SDisplay = "Hello World " ;  
System.out.println( SDisplay );  
}  
} 

使用下面命令：
Javadoc -private -d doc -author -version myHelloworld.Java
即可以生成漂亮的關(guān)于myHelloworld.Java的API文檔了。
上面例子中以@開頭的標(biāo)記就是Javadoc標(biāo)記。在Java程序中正確使用Javadoc標(biāo)記是一個良好的注釋習(xí)慣，將非常有助于Javadoc自動從源代碼文件生成完整的格式化API文檔。下面就對各種標(biāo)記進行詳細(xì)說明。
◇ @author name-text 指定生成文檔中的"作者"項，從JDK/SDK 1.0開始引入。name-text可以指定多個名字（使用","隔開）。文檔注釋可以包含多個類。
◇ {@docroot} 代表產(chǎn)生文檔的根路徑，從JDK/SDK 1.3開始引入。用法舉例如下
/**
*see the href={@docroot}/copyright.html>copyright>
*/
假定生成文檔的根目錄是doc，上面注釋所在的文件最后生成的文件是docutilityutl.html，那么"copyright"的鏈接會指向..copyright.html。
◇ @deprecated deprecated-text 添加注釋，表明不推薦使用該API。
◇ @exception class-name description @throw的同義標(biāo)記，從JDK/SDK 1.0開始引入。
◇ {@link package.class#member label} 插入指向package.class#member的內(nèi)嵌鏈接，從JDK/SDK 1.2開始引入。舉例說明，假定注釋中有如下文檔：
/** Use the {@link #getComponentAt(int, int) getComponentAt} method. */
那么Javadoc最終生成的HTML頁面中將有如下內(nèi)容
Use the getComponentAt method.
◇ @param parameter-name description 描述參數(shù)，從JDK/SDK 1.0開始引入。
◇ @return description 描述返回值，從JDK/SDK 1.0開始引入。
◇ @see reference 添加"參見"標(biāo)題，其中有指向reference的鏈接或者文本項，從JDK/SDK 1.0開始引入。@see標(biāo)記有三種形式，下面分別說明：
（1）、@see "string" 為"string"添加文本項，不產(chǎn)生鏈接。
（2）、@see Label 使用HTML標(biāo)記產(chǎn)生鏈接
（3）、@see package.class#member Label 使用Java語言的名字package.class #member產(chǎn)生鏈接。
◇ @serial field-description 用于缺省可序列化域的注釋，從JDK/SDK 1.2開始引入。
◇ @serialField field-name field-type field-description 建立Serializable類的serialPersistentFields成員的ObjectStreamField組件的文檔，從JDK/SDK 1.2開始引入。
◇ @serialData data-description data-description建立數(shù)據(jù)序列和類型的文檔，從JDK/SDK 1.2開始引入。
◇ @since since-text 利用since-text內(nèi)容為文檔增加"since"標(biāo)題，從JDK/SDK 1.1開始引入。
◇ @throws class-name description 與@exception同義。用class-name和description為輸出文檔添加"拋出"標(biāo)題，從JDK/SDK 1.2開始引入。
◇ @version version-text 添加"版權(quán)"標(biāo)題，從JDK/SDK 1.0開始引入。
上面介紹了標(biāo)準(zhǔn)doclet提供的所有標(biāo)記。不過，需要注意這些標(biāo)記的使用是有位置限制的。其中可以出現(xiàn)在類或者接口文檔注釋中的標(biāo)記有：@see、 {@link}、@since、@deprecated、@author、@version。可以出現(xiàn)在方法或者構(gòu)造器文檔注釋中的標(biāo)記有：@see、 {@link}、@since、@deprecated、@param、@return、@throws、@exception、 @serialData?？梢猿霈F(xiàn)在域文檔注釋中的有：@see、{@link}、@since、@desprecated、@serial、 @serialField。
除了Javadoc自身提供的標(biāo)準(zhǔn)標(biāo)記以外，我們可以定制自己的標(biāo)記嗎？當(dāng)然可以。只需要對Javadoc標(biāo)準(zhǔn)的doclet程序進行擴充即可。實際上，利用Javadoc提供的doclet API，不僅可以擴充doclet標(biāo)記，甚至還可以改變Javadoc的整個輸出。為了滿足需要，你可以使Javadoc輸出普通文本、XML文件等。由于擴充doclet涉及到Java編程，本文不再做深入介紹。
總之，Javadoc提供了完整規(guī)范的API文檔功能。在軟件項目管理中，合理地使用Javadoc不僅可以減少開發(fā)時的文檔工作量，提高效率；而且還非常有利于將來軟件的修改和維護。
JavaDoc 書寫規(guī)范：
1、 File Header Comments ： 每個文件都應(yīng)該加上文件頭標(biāo)記，包括文件名、修改歷史、版權(quán)信息和附加信息。例如：

/**  
* @(#)demo.Java 1.00 2002/05/27  
*  
* Copyright (c) 2000-2002 中國平安保險股份有限公司 版權(quán)所有  
* Ping An Insurance Company of China. All rights reserved.  
 
* This software is the confidential and proprietary   
* information of Ping An Insurance Company of China.   
* ("Confidential Information"). You shall not disclose   
* such Confidential Information and shall use it only  
* in accordance with the terms of the contract agreement   
* you entered into with Ping An.  
*/ 
 
2、class description：類信息，概括的描述類的功能和實現(xiàn)。  
/** class description  
*/ 
3、Variable Description：描述變量的意義和取值含義。  
/** var variable description  
*/ 

4、Method Description：標(biāo)明每個方法的輸入、輸出參數(shù)和返回值類型，說明特殊變量取值的含義。相關(guān)類文檔鏈接。

/** method description  
* @param var signification  
* @exception exception class name  
* @return return_value return signification  
*/ 

5、Association Description：關(guān)聯(lián)類文檔描述，在注釋當(dāng)中需要參引其它文檔描述的地方，可在相應(yīng)的注釋當(dāng)中如下插入：

/** method description  
* @param var signification  
* @exception exception class name  
* @return return_value return signification  
* @see package.class#member label  
*/ 

6、包描述文件：概括描述包的功能和設(shè)計概要。為每個包創(chuàng)建一個描述文件，命名為package.html，與包的Java文件放在一起。
注：Javadoc生成文檔時，會將該html文件的第一句放在package summary中，而把整個內(nèi)容放在Overview summary中

【編輯推薦】

1. 對Java編程思想的忠告
2. 和我共同了解Java是什么
3. 著名的Java論壇和網(wǎng)站
4. 2009年十大Java技術(shù)解決方案
5. 2008最值得學(xué)習(xí)的五種JAVA技術(shù)