Java本身附帶了一個(gè)很有用的工具Javadoc,它能將具有文檔注釋的類文件從源代碼轉(zhuǎn)換成Html格式。
Javadoc標(biāo)記有兩種:獨(dú)立(Standalone)標(biāo)記和內(nèi)聯(lián)(Inline)標(biāo)記。獨(dú)立標(biāo)記也就是那些常見(jiàn)的標(biāo)記,如@param, @return, 和@throws等。但還有一些不常見(jiàn)的,包括:
@author:這個(gè)標(biāo)記答應(yīng)你說(shuō)明代碼作者。它還能包含email地址、web站點(diǎn)以及其它有關(guān)作者的附加信息。
@since: 這個(gè)標(biāo)記答應(yīng)你指定類版本或者產(chǎn)品規(guī)格。Sun公司采用這種辦法讓用戶知道JDK各個(gè)版本的特點(diǎn)。
@version: 這個(gè)標(biāo)記答應(yīng)你指定代碼版本。你在這里放置的版本信息會(huì)由代碼資料庫(kù)自動(dòng)插入源代碼中去。例如,在CVS中,使用下列語(yǔ)法:
*@version $Id: Strings.java,v 1.1 2002/03/06 03:03:12 hen EXP $
則CVS將對(duì)其進(jìn)行更新。在上述例子中,Strings.java是文件名,1.1是源代碼的CVS版本號(hào), 2002/03/006 03:03:12是代碼放到CVS上的時(shí)間,hen則是放入代碼的用戶名稱。
另一種類型的標(biāo)記是內(nèi)聯(lián)標(biāo)記。這種標(biāo)記采用{@tag}的形式。在JDK1.2中,只有一種這樣的標(biāo)記{@link},它答應(yīng)開(kāi)發(fā)者創(chuàng)建超級(jí)鏈接從注釋部分連接到其它的Javadoc頁(yè)面或者本頁(yè)面的其它地方。
link內(nèi)聯(lián)標(biāo)記的通常形式是:
{@linkpackage.class#member label}
Label是位于注釋中間的文本,package.class#member指向一個(gè)具體的類或者方法。 Label通常和類名或者方法名稱相同。正如上述語(yǔ)法所顯示,這個(gè)標(biāo)記鏈接到其它類的任何成員,包括方法、屬性、靜態(tài)變量以及構(gòu)造函數(shù)。以下是一些例子:
連接到同一類的屬性,采用:
@link#KEY
以上不需要package.class,并且label名稱就采用成員名稱即可。
連接到同一類的方法,采用:
{@link#getComponentAt(int, int) getComponentAt}
連接到其它類,采用:
{@linkjava.util.Map Map}
本站僅提供存儲(chǔ)服務(wù),所有內(nèi)容均由用戶發(fā)布,如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容,請(qǐng)
點(diǎn)擊舉報(bào)。