雖然在Java文件中編寫注釋后,馬上可以切換到內(nèi)容窗格的Doc視圖頁代碼中對應(yīng)的Javadoc文檔,但在Doc視圖頁中生成的文檔僅是不完整的"范本"。首先,沒有導(dǎo)航樹,其次沒有生成通過@see或@link關(guān)聯(lián)內(nèi)容的鏈接。所以你可以把Doc視圖頁中的Javadoc文檔看成是Javadoc最終版本的預(yù)覽。
要為工程產(chǎn)生完整的Javadoc文檔,必須通過Javadoc向?qū)В谶@節(jié)里,我們用Javadoc向?qū)閖avadoc工程創(chuàng)建完整的Javadoc文檔。
1.File->New...->Build->雙擊Javadoc圖標(biāo),彈出創(chuàng)建Javadoc的向?qū)?,如下圖所示:
Doclet name中包含了兩個(gè)選項(xiàng),分別是Standard Doclet和JDK 1.1 Doclet。Standard Doclet將采用JDK 1.3以上的格式創(chuàng)建Javadoc文檔,如果選用JDK 1.1 Doclet,許多設(shè)置選項(xiàng)將無法使用。
這里,我們接受默認(rèn)的Standard Doclet選項(xiàng),按Next到下一步。
注意:
JDK 1.4和JDK5.0并未提供對JDK 1.1 Doclet的支持,所以如果你的工程的JDK是JDK 1.4或JDK5.0,當(dāng)你選用JDK 1.1 Doclet創(chuàng)建Javadoc文檔時(shí),你將得到以下的錯(cuò)誤信息:
JDK 1.1 Doclet: Cannot find doclet com.sun.tools.doclets.oneone.OneOne
on the class path. Check available in JDK configured to be used.
2.指定Javadoc節(jié)點(diǎn)名和創(chuàng)建選項(xiàng)
·Name:Stand Doclet,在完成這個(gè)向?qū)Ш?,在工程窗格資源樹中會(huì)創(chuàng)建一個(gè)節(jié)點(diǎn),表示工程的Javadoc文檔,這里設(shè)置的就是節(jié)點(diǎn)的名字。
·Output directory:D:/javadoc/doc,Javadoc文件的輸出目錄。接受這個(gè)默認(rèn)的設(shè)置。
·4個(gè)創(chuàng)建選項(xiàng)。
* Show console output:在創(chuàng)建Javadoc文檔時(shí),在信息窗格中顯示出創(chuàng)建文檔的報(bào)告信息,在默認(rèn)情況下,這個(gè)選項(xiàng)沒有勾選,我們將其選中,以便在創(chuàng)建文檔時(shí),看到各種報(bào)告信息,如下圖所示:
* Always run Javadoc When building the project:設(shè)置是否需要在Rebuild工程時(shí),創(chuàng)建Javadoc文檔。在默認(rèn)情況上這個(gè)選項(xiàng)是勾選的,由于每次Rebuild工程時(shí),都會(huì)連帶編譯并產(chǎn)生工程的Javadoc文檔,這將浪費(fèi)較多的時(shí)間。你大可在需要?jiǎng)?chuàng)建Javadoc文檔時(shí),通過資源樹的Javadoc節(jié)點(diǎn)手工來創(chuàng)建它。所以我們?nèi)コ@個(gè)選項(xiàng)設(shè)置。
* Use project JDK when running Javadoc:勾選這個(gè)設(shè)置項(xiàng)中,JBuilder將用工程所用的JDK所帶的Doclet來創(chuàng)建Javadoc文檔,否則使用JBuilder自帶的JDK1.4所帶的Doclet。
* Include project test path directory:用JUnit測試框架生成的測試類,將統(tǒng)一放在工程目錄的test子目錄下。選擇該設(shè)置項(xiàng)后,測試類的Javadoc文檔將和工程其他類的文檔一起輸出。在一般情況下,這并不是我們所希望的,所以去除這個(gè)選項(xiàng)。
要為工程產(chǎn)生完整的Javadoc文檔,必須通過Javadoc向?qū)В谶@節(jié)里,我們用Javadoc向?qū)閖avadoc工程創(chuàng)建完整的Javadoc文檔。
1.File->New...->Build->雙擊Javadoc圖標(biāo),彈出創(chuàng)建Javadoc的向?qū)?,如下圖所示:
Doclet name中包含了兩個(gè)選項(xiàng),分別是Standard Doclet和JDK 1.1 Doclet。Standard Doclet將采用JDK 1.3以上的格式創(chuàng)建Javadoc文檔,如果選用JDK 1.1 Doclet,許多設(shè)置選項(xiàng)將無法使用。
這里,我們接受默認(rèn)的Standard Doclet選項(xiàng),按Next到下一步。
注意:
JDK 1.4和JDK5.0并未提供對JDK 1.1 Doclet的支持,所以如果你的工程的JDK是JDK 1.4或JDK5.0,當(dāng)你選用JDK 1.1 Doclet創(chuàng)建Javadoc文檔時(shí),你將得到以下的錯(cuò)誤信息:
JDK 1.1 Doclet: Cannot find doclet com.sun.tools.doclets.oneone.OneOne
on the class path. Check available in JDK configured to be used.
2.指定Javadoc節(jié)點(diǎn)名和創(chuàng)建選項(xiàng)
·Name:Stand Doclet,在完成這個(gè)向?qū)Ш?,在工程窗格資源樹中會(huì)創(chuàng)建一個(gè)節(jié)點(diǎn),表示工程的Javadoc文檔,這里設(shè)置的就是節(jié)點(diǎn)的名字。
·Output directory:D:/javadoc/doc,Javadoc文件的輸出目錄。接受這個(gè)默認(rèn)的設(shè)置。
·4個(gè)創(chuàng)建選項(xiàng)。
* Show console output:在創(chuàng)建Javadoc文檔時(shí),在信息窗格中顯示出創(chuàng)建文檔的報(bào)告信息,在默認(rèn)情況下,這個(gè)選項(xiàng)沒有勾選,我們將其選中,以便在創(chuàng)建文檔時(shí),看到各種報(bào)告信息,如下圖所示:
* Always run Javadoc When building the project:設(shè)置是否需要在Rebuild工程時(shí),創(chuàng)建Javadoc文檔。在默認(rèn)情況上這個(gè)選項(xiàng)是勾選的,由于每次Rebuild工程時(shí),都會(huì)連帶編譯并產(chǎn)生工程的Javadoc文檔,這將浪費(fèi)較多的時(shí)間。你大可在需要?jiǎng)?chuàng)建Javadoc文檔時(shí),通過資源樹的Javadoc節(jié)點(diǎn)手工來創(chuàng)建它。所以我們?nèi)コ@個(gè)選項(xiàng)設(shè)置。
* Use project JDK when running Javadoc:勾選這個(gè)設(shè)置項(xiàng)中,JBuilder將用工程所用的JDK所帶的Doclet來創(chuàng)建Javadoc文檔,否則使用JBuilder自帶的JDK1.4所帶的Doclet。
* Include project test path directory:用JUnit測試框架生成的測試類,將統(tǒng)一放在工程目錄的test子目錄下。選擇該設(shè)置項(xiàng)后,測試類的Javadoc文檔將和工程其他類的文檔一起輸出。在一般情況下,這并不是我們所希望的,所以去除這個(gè)選項(xiàng)。