Eclipse中生成javadoc【Z】

liuchang0001發表於2011-05-09

javadoc.exe是自動生成java文件的小工具,利用這個文件,可以很容易的瞭解整個工程、包、類的情況。當然,如果你註釋做的很到位的話,對於自己,還是其他想要閱讀你的程式的人來說,都是一件很享受的事情。

       我是在eclipse使用這個小工具的,使用起來很方便。有三個常見的入口

  (1)File —> Export —> java —> javadoc

  (2)Project —> Generate Javadoc

  (3)在工程上右鍵 —> Export —> java —> javadoc

  三個入口殊途而同歸,進入javadoc generation介面。之後你必須要做的事情有:Configure,即找到javadoc.exe的路徑,在java安裝路徑下。選擇要生成 javadoc的工程,選擇你要輸出的位置,預設輸出到工程下的doc資料夾下面。之後的步驟都是可選的,這裡有一個要說明的問題:字符集。

  在Extra javadoc option中可以設定:

  -encoding UTF-8     //-encoding charsetName 是指原始檔編碼

  -charset UTF-8      //-charset charsetName 用於跨平臺檢視文件的字符集,它對應著你生成的html

           檔案中的頭部的charset

  Finish,然後就可以看到生成的文件了,很高效的工具。

  如果想了解更多的javadoc的選項:進入命令列,輸入:javadoc -help ,如果你的環境變數配置的正確的話,你可以看到全部的選項,這些選項在eclipse中都可以使用的。

  javadoc在命令列中的用法是:

  javadoc [選項] [軟體包名稱] [原始檔] [@file]

  具體的使用,自己嘗試吧。

相關文章