源代碼在C:\src 目錄下,其中 com.taiji其下可能有數十個子包,數百(千)個Java文件。目錄結構如下:

- C:\
    | src\
      | com\
        | taiji\
            | ***

怎么才能以最簡捷的方式生成所有的API文檔呢?

c:\>
c:\>cd src
c:\src>javadoc -d doc -subpackages com.taiji

這樣就搞定了,最終生成的API文檔位于 c:\src\doc 目錄(該目錄是由javadoc.exe自動生成的)。

上面的用法利用了“當前目錄”和“相對路徑”,當然也可以用絕對路徑:

...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.taiji
最終生成的API文檔位于 c:\doc 目錄(該目錄同樣是由javadoc.exe自動生成的)。


總結一下:

我們只用到了javadoc的三個參數: -d,-subpackages,-sourcepath,其中:

參數 說明
-d 指定API文檔的輸出目錄,默認是當前目錄。建議總是指定該參數。
-sourcepath 指定源代碼路徑,默認是當前目錄。 此參數通常是必須的。
-subpackages 以遞歸的方式處理各子包。關鍵參數!如果不使用本參數,每次只能處理一個子包(或需手工列出所有子包)。


注:以上示例要求 javadoc.exe 所在路徑位于系統環境變量“PATH”中。


補充兩點:

使用參數 -author 可以將作者信息(@author ***)導出到最終生成的API文檔中, -version 可以生成版本信息。

最終完整的命令行是:

...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.taiji -author -version

第二點是java源程序里面必須寫上package com.taiji.*相匹配的包名,否則javadoc會找不到源程序。