大家都知道,J2SE5中的javadoc.exe的命令行可選參數多達五十余個(gè),其復雜性可想而知,是不是看著(zhù)頭都大了呢?但通常情況下,我們不想那么麻煩!
假設源代碼在 C:\src 目錄下,其中 com.liigo 是主包,其下可能有數十個(gè)子包,數百(千)個(gè)Java文件。目錄結構大約是這樣的:
- C:\
| src\
| com\
| liigo\
| ***
怎么才能以最簡(jiǎn)捷的方式生成所有的API文檔呢?
c:\>
c:\>cd src
c:\src>javadoc -d doc -subpackages com.liigo
這樣就搞定了,最終生成的API文檔位于 c:\src\doc 目錄(該目錄是由javadoc.exe自動(dòng)生成的)。
上面的用法利用了“當前目錄”和“相對路徑”,當然也可以用絕對路徑:
...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo
最終生成的API文檔位于 c:\doc 目錄(該目錄同樣是由javadoc.exe自動(dòng)生成的)。
總結一下:
我們只用到了javadoc的三個(gè)參數: -d,-subpackages,-sourcepath,其中:
參數 說(shuō)明
-d 指定API文檔的輸出目錄,默認是當前目錄。建議總是指定該參數。
-sourcepath 指定源代碼路徑,默認是當前目錄。 此參數通常是必須的。
-subpackages 以遞歸的方式處理各子包。關(guān)鍵參數!如果不使用本參數,每次只能處理一個(gè)子包(或需手工列出所有子包)。
注:以上示例要求 javadoc.exe 所在路徑位于系統環(huán)境變量“PATH”中。
補充一點(diǎn):
使用參數 -author 可以將作者信息(@author ***)導出到最終生成的API文檔中, -version 可以生成版本信息。如果是自己寫(xiě)的一個(gè)包,千萬(wàn)不要忘了用 -author 哦:)
最終完整的命令行是:
...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo -author -version
聯(lián)系客服