第一個(gè)參數(shù) -encoding UTF-8 表示你的源代碼(含有符合 JavaDoc 標(biāo)準(zhǔn)的注釋)是基于 UTF-8 編碼的,,以免處理過(guò)程中出現(xiàn)中文等非英語(yǔ)字符亂碼,;第二個(gè)參數(shù) -charset UTF-8 表示在處理并生成 JavaDoc 超文本時(shí)使用的字符集也是以 UTF-8 為編碼,目前所有瀏覽器都支持 UTF-8,,這樣最具有通用性,,支持中文非常好;第三個(gè)參數(shù) -windowtitle 表示生成的 JavaDoc 超文本在瀏覽器中打開(kāi)時(shí),,瀏覽器窗口標(biāo)題欄顯示的文字內(nèi)容,;第四個(gè)參數(shù) -link 很重要,它表示你生成的 JavaDoc 中涉及到很多對(duì)其他外部 Java 類的引用,,是使用全限定名稱還是帶有超鏈接的短名稱,,舉個(gè)例子,我創(chuàng)建了一個(gè)方法 public void func(String arg),,這個(gè)方法在生成 JavaDoc 時(shí)如果不指定 -link 參數(shù),,則 JavaDoc 中對(duì)該方法的表述就會(huì)自動(dòng)變?yōu)?public void func(java.lang.String arg),因?yàn)?String 這個(gè)類對(duì)我自己實(shí)現(xiàn)的類來(lái)講就是外部引用的類,,雖然它是 Java 標(biāo)準(zhǔn)庫(kù)的類,。如果指定了 -link http://docs.oracle.com/javase/7/docs/api 參數(shù),則 javadoc.exe 在生成 JavaDoc 時(shí),,會(huì)使用 String 這樣的短名稱而非全限定名稱 java.lang.String,,同時(shí)自動(dòng)為 String 短名稱生成一個(gè)超鏈接,指向官方 JavaSE 標(biāo)準(zhǔn)文檔 http://docs.oracle.com/javase/7/docs/api 中對(duì) String 類的詳細(xì)文檔地址,。-link 實(shí)質(zhì)上是告訴 javadoc.exe 根據(jù)提供的外部引用類的 JavaDoc 地址去找一個(gè)叫 package-list 的文本文件,,在這個(gè)文本文件中包含了所有外部引用類的全限定名稱,因此生成的新 JavaDoc 不必使用外部引用類的全限定名,,只需要使用短名稱,,同時(shí)可以自動(dòng)創(chuàng)建指向其外部引用 JavaDoc 中的詳細(xì)文檔超鏈接,。每個(gè) JavaDoc 都會(huì)在根目錄下有一個(gè) package-list 文件,包括我們自己生成的 JavaDoc,。 |
|