JavaDoc注釋的使用
Javadoc是Sun公司提供的一個(gè)技術(shù)，它從程序源代碼中抽取類、方法、成員等注釋形成一個(gè)和源代碼配套的API幫助文檔。也就是說(shuō)，只要在編寫程序時(shí)以一套特定的標(biāo)簽作注釋，在程序編寫完成后，通過(guò)Javadoc就可以同時(shí)形式程序的開發(fā)文檔了。
Javadoc輸出的是一些HTML文件，我們可以通過(guò)WEB瀏覽器來(lái)查看它。
Javadoc的語(yǔ)法：
所有Javadoc都只能源于/**開始和*/結(jié)束。使用javadoc有二種方式：一種是嵌入HTML；另一種是使用文檔標(biāo)簽。所謂文檔標(biāo)簽就是一些以 “@”開頭的命令，且“@”要置于注釋行的最前面。而“行內(nèi)文檔標(biāo)簽”則可以出現(xiàn)在Javadoc注釋中的任何地方，它們也是以“@”字符開頭，但要括在共括號(hào)內(nèi)。
Javadoc只能為public或者protected成員進(jìn)行文檔注釋。private和包內(nèi)訪問(wèn)的成員的注釋會(huì)被忽略掉。這樣做是有道理的，因?yàn)橹挥衟ublic和protected成員才能在文件之外被使用，這也體現(xiàn)了封裝性的優(yōu)點(diǎn)。
嵌入HTML：
Javadoc將HTML代碼嵌入到所生成的HTML文件中。這樣能充分利用HTML的功能。比如：
- /**
- *<b>
- *this is my test program;
- *</b>
- */
但一般我們不要在HTML里使用標(biāo)題，如<h1><hr>，因?yàn)镴avadoc會(huì)插入自己的標(biāo)題，我們的標(biāo)題可能會(huì)干擾它。
常用的標(biāo)簽：
1) @see：引用其它類的文檔，相當(dāng)于超鏈接，Javadoc會(huì)在其生成的HTML文件中，將@see標(biāo)簽鏈到其他的文檔
@see classname
這樣在生成的文檔中會(huì)出現(xiàn)"See Also"的超鏈蛸。但是Javadoc不去檢查你的超鏈接是否有效。
2) {@link package.class#member label}
與@See的功能一樣，只是用label作主超鏈接，而不是用"see also"
3) {@docRoot}：標(biāo)簽產(chǎn)生 到文檔根目錄的相對(duì)路徑，用于文檔樹頁(yè)面的顯式超鏈接
4) {@inheritDoc}：標(biāo)簽從當(dāng)前這個(gè)類的最直接的基類中繼承相關(guān)文檔到當(dāng)前的文檔注釋中。
5) @version：使用方法為@version 2.2.1.2...
2.2.1.2...是我們作的版本說(shuō)明信息
6) @author：使用方法為 @author PowerFedora powpro@hotmail.com
也就是說(shuō)我們可以在@author后加上作者名字，email等聯(lián)系方式
7) @since：這個(gè)標(biāo)簽允許你指定程序最早使用的版本。
比如我們看JDK Document里的每個(gè)類最后都會(huì)說(shuō)明從JDK哪個(gè)版本開始啟用。
8) @param：@param name 用于輸入客戶的姓名
@param后面是方法的參數(shù)，以及相應(yīng)的說(shuō)明
我們可以使用任意數(shù)量的此標(biāo)簽，每個(gè)參數(shù)都可以有這樣一個(gè)標(biāo)簽
9) @return this is description
@return后面是描述返回值的含義，可以延續(xù)幾行。
10) @throws fully-qualified-class-name description
fully-qualified-class-name為異常類的完整名字，
而description告訴你為什么此異常會(huì)在方法中調(diào)用出現(xiàn)。
11) @deprecated：用于指出一些舊特性已由改進(jìn)的新特性所取代，建議用戶不要再使用舊特性。
Sample：
- import java.util.*;
- /** 這是一個(gè)為了測(cè)試Javadoc而專門寫的類
- * 功能是打印字符串 HelloWorld
- * @author AuthorName
- * @version 1.0
- */
- public class JavaDocTest {
- /** 這里的main函數(shù)，作為java程序的入口
- * @param 參數(shù)為一個(gè)String對(duì)象數(shù)組
- * @return 沒(méi)有返回值的內(nèi)容
- * @exception exceptions 沒(méi)有異常被拋出
- */
- public static void main(String[] args){
- System.out.print("HelloWorld!");
- }
- }
如果使用eclipse的話，完全不需要背這些標(biāo)簽。在需要注釋的地方打上/**之后，再打@符號(hào)eclipse會(huì)自動(dòng)顯示所支持的標(biāo)簽供選擇。
同樣在生成HTML文檔時(shí)也可以利用eclipse的export功能直接導(dǎo)出，否則用javadoc手工來(lái)生成的話是件相當(dāng)痛苦的事情。
1.編寫一小段程序，體會(huì)文檔注釋的用法，并通過(guò)文檔生成工具提取文檔注釋，形成程序文檔。
代碼如下：
- //： Property.java
- import java.util.*;
- /** The first example program in "Thinking in Java."
- * Lists system information on current machine.
- * @author Bruce Eckel
- * @author http：//www.EckelObjects.com/Eckel
- * @version 1.0
- */
- public class Property {
- /** Sole entry point to class & application
- * @param args Array of string arguments
- * @exception No exceptions are thrown
- */
- public static void main(String args[]) {
- System.out.println(new Date());
- System.getProperties().list(System.out);
- System.out.println("--- Memory Usage：");
- Runtime rt = Runtime.getRuntime();
- System.out.println("Total Memory = "
- + rt.totalMemory()
- + " Free Memory = "
- + rt.freeMemory());
- }}
利用Myeclipse生產(chǎn)javadoc文檔的步驟如下：
1.選擇File->Export->javadoc，下一步。
2.Javadoc comand選擇JDK的bin目錄下的javadoc.exe。選擇要生成的源代碼和javadoc保存的目的路徑，下一步。
3.Document title輸入標(biāo)題，下一步。
4.overview輸入啟動(dòng)指定的overview文件路徑，Extra Javadoc options輸入
-windowtitle 'Type B Monitor'[瀏覽器顯示標(biāo)題]
-bottom <center>Travelsky</center>[底部顯示文本]，下一步。
【編輯推薦】
