使用Javadoc標記你需要的信息

2019-11-18 13:26:13

字體：大中小

來源：轉載

供稿：網(wǎng)友

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

上一篇：Jar clone的版本沖突

下一篇：用Java實現(xiàn)斷點續(xù)傳(HTTP)