使用javadoc命令生成api文檔:
創建java源文件包。java文件都是存放在一個package包中,這樣方便對java文件進行操作和區分,首先在磁碟上創建文件夾一樣的方式創建package包。
創建java源文件。在包下,創建與文件名相同的java源文件,輸入一些文檔注釋,這些文檔注釋用於自動的api文件進行說明使用。
進入java源文件目錄。通過cd等windows命令進入java源文件包所在的磁碟位置。
查看javadoc命令使用說明。如果是第一次使用javadoc命令,可以通過javadoc -help命令查看javadoc使用說明。
開始創建api文件。使用命令輸入javadoc -d javaapi -header 測試的API -doctitle 這是我的第一個文檔注釋 -version -author javadoc/Hello.java 進行文檔生成。-d:文件存儲位置; -head:文件頭部名稱; -version:顯示版本; -author:顯示作者; javadoc/Hello.java 處理的文件包以及java源文件。
查看生成的api文件。創建成功之後,就會自動創建指定的文件夾下生成api文件。打開index.html就是api文件的入口。
2. 如何使用javadoc
假設源代碼在 C:\src 目錄下,其中 com.liigo 是主包,其下可能有數十個子包,數百(千)個Java文件。目錄結構大約是這樣的:
- C:\
| src\
| com\
| liigo\
| ***
怎麼才能以最簡捷的方式生成所有的API文檔呢?
c:\>
c:\>cd src
c:\src>javadoc -d doc -subpackages com.liigo
這樣就搞定了,最終生成的API文檔位於 c:\src\doc 目錄(該目錄是由javadoc.exe自動生成的)。
上面的用法利用了「當前目錄」和「相對路徑」,當然也可以用絕對路徑:
...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo
最終生成的API文檔位於 c:\doc 目錄(該目錄同樣是由javadoc.exe自動生成的)。
總結一下:
我們只用到了javadoc的三個參數: -d,-subpackages,-sourcepath,其中:
參數 說明
-d 指定API文檔的輸出目錄,默認是當前目錄。建議總是指定該參數。
-sourcepath 指定源代碼路徑,默認是當前目錄。 此參數通常是必須的。
-subpackages 以遞歸的方式處理各子包。關鍵參數!如果不使用本參數,每次只能處理一個子包(或需手工列出所有子包)。
註:以上示例要求 javadoc.exe 所在路徑位於系統環境變數「PATH」中。
補充一點:
使用參數 -author 可以將作者信息(@author ***)導出到最終生成的API文檔中, -version 可以生成版本信息。如果是自己寫的一個包,千萬不要忘了用 -author 哦:)
最終完整的命令行是:
...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo -author -version
3. Java Javadoc命令
javadoc 命令是用來生成文檔的。確保你的hello.java 文件裡面有些注釋。否則就是空的。或者你打開其他的html文件看看
4. 常見java的命令有些什麼
javac:將源代碼編譯為class文件
java:執行class文件
javadoc:生成幫助文檔及API
jar:將代碼歸檔,生成一個jar包
備註:後綴為.exe的文件是一個應用程序的執行文件(客戶端),
相當於java代碼裡面的主方法(main方法),
執行每一個java命令,相對於執行對應的源代碼的主方法
2.1.2 lib:存放Java類庫文件;一些jar包 工具類
2.1.3 jre: 客戶端目錄,供客戶使用
2.1.4 demo:存放演示文件,可能沒有這個目錄
5. 哪種注釋方法能夠支持javadoc命令
文檔注釋是Java裡面的一個比較厲害的功能,它可以用於注釋類、屬性、方法等說明,而且通過JDK工具javadoc直接生成相關文檔,文檔注釋的基本格式為「/**...*/」,不僅僅如此,文檔注釋本身還存在語法:
1. 文檔和文檔注釋的格式化:
生成的文檔是HTML格式的,而這些HTML格式的標識符並不是javadoc加的,而是我們在寫注釋的時候寫上去的。因此在格式化文檔的時候需要適當地加入HTML標簽,比如,需要換行時,不是敲入一個回車符,而是寫入,如果要分段,就應該在段前寫入。
2. 文檔注釋的三部分根據在文檔中顯示的效果,文檔注釋分為三部分:
第一部分是簡述。文檔中,對於屬性和方法都是先有一個列表,然後才在後面一個一個的詳細的說明。列表中屬性名或者方法名後面那段說明就是簡述。
第二部分是詳細說明部分。該部分對屬性或者方法進行詳細的說明,在格式上沒有什麼特殊的要求,可以包含若干個點號。
第三部分是特殊說明部分。這部分包括版本說明、參數說明、返回值說明等。