在軟件項(xiàng)目管理過(guò)程中，如何保證程序代碼與軟件技術(shù)文檔一致可以說(shuō)是最令人頭疼的一件事情了。不管是先修改代碼，還是先修改文檔，對(duì)各種記錄的管理都是一件麻煩事。而且，二者在改動(dòng)上的一致性、實(shí)時(shí)性還很難得到保證。令人高興的是Java平臺(tái)的設(shè)計(jì)者充分考慮到了這一點(diǎn)，他們十分"體貼"地為Java開(kāi)發(fā)者們帶來(lái)一個(gè)文檔管理工具--javadoc。
javadoc利用Java編譯程序javac對(duì)程序代碼源文件中的聲明和文檔注釋進(jìn)行語(yǔ)法分析，并在默認(rèn)情況下生成一組HTML文檔來(lái)描述類(lèi)、內(nèi)部類(lèi)、接口、構(gòu)造函數(shù)、方法和域。不過(guò)在運(yùn)行過(guò)程中，它也使用了Java平臺(tái)的環(huán)境變量classpath來(lái)確定類(lèi)查找路徑。這樣當(dāng)涉及類(lèi)和內(nèi)部類(lèi)的有關(guān)描述時(shí)，是否正確地設(shè)置了classpath變量可能會(huì)影響到j(luò)avadoc命令是否可以完全成功執(zhí)行。
javadoc產(chǎn)生的默認(rèn)文件列表如下：
基本頁(yè)面文件：
calssname.html 類(lèi)或者接口描述文件，一個(gè)文件對(duì)應(yīng)一個(gè)類(lèi)或者接口
package-summary.html 包摘要文件，一個(gè)文件對(duì)應(yīng)一個(gè)包
overview-summary.html 總的摘要文件
交叉引用頁(yè)面文件：
overview-tree.html 所有包的類(lèi)層次頁(yè)面
package-tree.html 某個(gè)包的類(lèi)層次頁(yè)面
package-use.html 包用法頁(yè)面
class-use\classname.html 類(lèi)用法頁(yè)面
deprecated-list.html 不鼓勵(lì)使用的方法的頁(yè)面
serialized-form.html 序列化頁(yè)面
index-*.html 索引文件
支持文件：
help-doc.html 幫助文件
index.html 引導(dǎo)頁(yè)面，是整個(gè)文檔的入口
*-frame.html 框架文件
stylesheet.css 樣式表文件
doc-files目錄 保存與HTML相關(guān)的一些雜文件。例如圖片文件等。
javadoc的命令行語(yǔ)法如下：
javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]
參數(shù)可以按照任意順序排列。下面分別就這些參數(shù)和相關(guān)的一些內(nèi)容進(jìn)行說(shuō)明：
Packagenames 包列表。這個(gè)選項(xiàng)可以是一系列的包名（用空格隔開(kāi)），例如java.lang java.lang.reflect
java.awt。不過(guò)，因?yàn)閖avadoc不遞歸作用于子包，不允許對(duì)包名使用通配符；所以你必須顯示地列出希望建立文檔的每一個(gè)包。
Sourcefiles 源文件列表。這個(gè)選項(xiàng)可以是一系列的源文件名（用空格隔開(kāi)），可以使用通配符。javadoc允許四種源文件：類(lèi)源代碼文件、包描述文件、總體概述文件、其他雜文件。
◇ 類(lèi)源代碼文件：類(lèi)或者接口的源代碼文件。
◇ 包描述文件：每一個(gè)包都可以有自己的包描述文件。包描述文件的名稱(chēng)必須是"package.html"，與包的.java文件放置在一起。包描述文件的內(nèi)容通常是使用HTML標(biāo)記寫(xiě)的文檔。javadoc執(zhí)行時(shí)將自動(dòng)尋找包描述文件。如果找到，javadoc將首先對(duì)描述文件中之間的內(nèi)容進(jìn)行處理，然后把處理結(jié)果放到該包的Package
Summary頁(yè)面中，最后把包描述文件的第一句（緊靠）放到輸出的Overview summary頁(yè)面中，并在語(yǔ)句前面加上該包的包名。
◇ 總體概述文件：javadoc可以創(chuàng)建一個(gè)總體概述文件描述整個(gè)應(yīng)用或者所有包?？傮w概述文件可以被任意命名，也可以放置到任意位置。-overview選項(xiàng)可以指示總體概述文件的路徑和名稱(chēng)?？傮w概述文件的內(nèi)容是使用HTML標(biāo)記寫(xiě)的文檔。javadoc在執(zhí)行的時(shí)候，如果發(fā)現(xiàn)-overview選項(xiàng)，那么它將首先對(duì)文件中之間的內(nèi)容進(jìn)行處理；然后把處理后的結(jié)果放到輸出的Overview
summary 頁(yè)面的底部；最后把總體概述文件中的第一句放到輸出的Overview summary頁(yè)面的頂部。
◇ 其他雜文件：這些文件通常是指與javadoc輸出的HTML文件相關(guān)的一些圖片文件、Java源代碼文件（.java）、Java程序（.class）、Java小程序（Applets）、HTML文件。這些文件必須放在doc-files目錄中。每一個(gè)包都可以有自己的doc-files目錄。舉個(gè)例子，你希望在java.awt.Button的HTML文檔中使用一幅按鈕的圖片（Button.gif）。首先，你必須把圖片文件放到C:\user\src\java\awt\doc-files\中；然后在Button.java文件中加入下面注釋
javadoc利用Java編譯程序javac對(duì)程序代碼源文件中的聲明和文檔注釋進(jìn)行語(yǔ)法分析，并在默認(rèn)情況下生成一組HTML文檔來(lái)描述類(lèi)、內(nèi)部類(lèi)、接口、構(gòu)造函數(shù)、方法和域。不過(guò)在運(yùn)行過(guò)程中，它也使用了Java平臺(tái)的環(huán)境變量classpath來(lái)確定類(lèi)查找路徑。這樣當(dāng)涉及類(lèi)和內(nèi)部類(lèi)的有關(guān)描述時(shí)，是否正確地設(shè)置了classpath變量可能會(huì)影響到j(luò)avadoc命令是否可以完全成功執(zhí)行。
javadoc產(chǎn)生的默認(rèn)文件列表如下：
基本頁(yè)面文件：
calssname.html 類(lèi)或者接口描述文件，一個(gè)文件對(duì)應(yīng)一個(gè)類(lèi)或者接口
package-summary.html 包摘要文件，一個(gè)文件對(duì)應(yīng)一個(gè)包
overview-summary.html 總的摘要文件
交叉引用頁(yè)面文件：
overview-tree.html 所有包的類(lèi)層次頁(yè)面
package-tree.html 某個(gè)包的類(lèi)層次頁(yè)面
package-use.html 包用法頁(yè)面
class-use\classname.html 類(lèi)用法頁(yè)面
deprecated-list.html 不鼓勵(lì)使用的方法的頁(yè)面
serialized-form.html 序列化頁(yè)面
index-*.html 索引文件
支持文件：
help-doc.html 幫助文件
index.html 引導(dǎo)頁(yè)面，是整個(gè)文檔的入口
*-frame.html 框架文件
stylesheet.css 樣式表文件
doc-files目錄 保存與HTML相關(guān)的一些雜文件。例如圖片文件等。
javadoc的命令行語(yǔ)法如下：
javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]
參數(shù)可以按照任意順序排列。下面分別就這些參數(shù)和相關(guān)的一些內(nèi)容進(jìn)行說(shuō)明：
Packagenames 包列表。這個(gè)選項(xiàng)可以是一系列的包名（用空格隔開(kāi)），例如java.lang java.lang.reflect
java.awt。不過(guò)，因?yàn)閖avadoc不遞歸作用于子包，不允許對(duì)包名使用通配符；所以你必須顯示地列出希望建立文檔的每一個(gè)包。
Sourcefiles 源文件列表。這個(gè)選項(xiàng)可以是一系列的源文件名（用空格隔開(kāi)），可以使用通配符。javadoc允許四種源文件：類(lèi)源代碼文件、包描述文件、總體概述文件、其他雜文件。
◇ 類(lèi)源代碼文件：類(lèi)或者接口的源代碼文件。
◇ 包描述文件：每一個(gè)包都可以有自己的包描述文件。包描述文件的名稱(chēng)必須是"package.html"，與包的.java文件放置在一起。包描述文件的內(nèi)容通常是使用HTML標(biāo)記寫(xiě)的文檔。javadoc執(zhí)行時(shí)將自動(dòng)尋找包描述文件。如果找到，javadoc將首先對(duì)描述文件中之間的內(nèi)容進(jìn)行處理，然后把處理結(jié)果放到該包的Package
Summary頁(yè)面中，最后把包描述文件的第一句（緊靠）放到輸出的Overview summary頁(yè)面中，并在語(yǔ)句前面加上該包的包名。
◇ 總體概述文件：javadoc可以創(chuàng)建一個(gè)總體概述文件描述整個(gè)應(yīng)用或者所有包?？傮w概述文件可以被任意命名，也可以放置到任意位置。-overview選項(xiàng)可以指示總體概述文件的路徑和名稱(chēng)?？傮w概述文件的內(nèi)容是使用HTML標(biāo)記寫(xiě)的文檔。javadoc在執(zhí)行的時(shí)候，如果發(fā)現(xiàn)-overview選項(xiàng)，那么它將首先對(duì)文件中之間的內(nèi)容進(jìn)行處理；然后把處理后的結(jié)果放到輸出的Overview
summary 頁(yè)面的底部；最后把總體概述文件中的第一句放到輸出的Overview summary頁(yè)面的頂部。
◇ 其他雜文件：這些文件通常是指與javadoc輸出的HTML文件相關(guān)的一些圖片文件、Java源代碼文件（.java）、Java程序（.class）、Java小程序（Applets）、HTML文件。這些文件必須放在doc-files目錄中。每一個(gè)包都可以有自己的doc-files目錄。舉個(gè)例子，你希望在java.awt.Button的HTML文檔中使用一幅按鈕的圖片（Button.gif）。首先，你必須把圖片文件放到C:\user\src\java\awt\doc-files\中；然后在Button.java文件中加入下面注釋