javadoc

1.javadoc用於提取源文件中的文檔註釋,命令格式是:

javadoc -d 生成文檔存放的目錄  包名1  包名2  ...


2.注意:

(1)javadoc不能遞歸包的子包,所以要把包名及其子包名都列出來,才能給子包中的java文件生成文檔。

(2)包中必須有java源文件,否則javadoc命令執行失敗


3.例子:

在當前目錄下有一個com文件下,下面有一個dyc文件夾和一個hc文件夾,包裏面有一些*.java文件;當前目錄下還有一個文件夾help,用於存放生成的幫助文檔。

這樣編寫命令用來生成com.dyc包和com.hc包中的java文件的幫助文檔:

javadoc -d .\help com.dyc com.hc


4.還可以這樣

新建一個package.txt的文件,裏面寫想提取文檔的包名,比如:

com.dyc

com.hc


然後這樣運行javadoc命令

javadoc -d .\help @package.txt

也可以達到上面的效果!



5.link選項:

link選項用來爲標準類添加超鏈接

例如:

javadoc -d .\help @package.txt  -link http://docs.oracle.com/javase/6/docs/api/

那麼所有的標準類庫都會自動鏈接到oracle網站上的文檔




6.更詳細的用法參考

http://hi.baidu.com/wpdnztoqtecfike/item/7ef56fcb4567c216b77a2461







發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章