注釋格式以及各個(gè)主要簡(jiǎn)介
(1).單行(single-line)注釋?zhuān)骸?/……”
(2).塊(block)注釋?zhuān)骸?*……*/”
(3).文檔注釋?zhuān)骸?**……*/”
(4).javadoc注釋標(biāo)簽語(yǔ)法
@author 對(duì)類(lèi)的說(shuō)明標(biāo)明開(kāi)發(fā)該類(lèi)模塊的作者
@version 對(duì)類(lèi)的說(shuō)明標(biāo)明該類(lèi)模塊的版本
@see 對(duì)類(lèi)、屬性、方法的說(shuō)明參考轉(zhuǎn)向,也就是相關(guān)主題
@param 對(duì)方法的說(shuō)明對(duì)方法中某參數(shù)的說(shuō)明
@return 對(duì)方法的說(shuō)明對(duì)方法返回值的說(shuō)明
@exception 對(duì)方法的說(shuō)明對(duì)方法可能拋出的異常進(jìn)行說(shuō)明
@return_type返回類(lèi)型
@date 日期
@time時(shí)間
類(lèi)、方法、重寫(xiě)方法等類(lèi)型的注釋添加
打來(lái):Window->Preference->Java->Code Style->Code Template 然后展開(kāi)Comments節(jié)點(diǎn),選中你要添加注釋的類(lèi)型,
然后點(diǎn)擊edit,就是所有需設(shè)置注釋的元素,F(xiàn)就每一個(gè)元素逐一介紹:
點(diǎn)擊edit后,在pattern里按“ctrl“+”/”鍵,選擇要添加的種類(lèi),例如日期,作者、時(shí)間、返回類(lèi)型等等……
設(shè)置好以后,會(huì)在上圖的pattern下生成相應(yīng)代碼,如下圖所示:
(1)文件(Files)注釋標(biāo)簽:
目前沒(méi)有用到,可以不用設(shè)置。
(2)類(lèi)型(Types)注釋標(biāo)簽(類(lèi)的注釋?zhuān)?/p>
規(guī)范:
/**
* 類(lèi)的描述
* @authoryourname
* @Time 2012-11-20 14:49:01
*
*/
注釋的pattern:
/**
* @Description:${todo}
* @author:${user}
* @time:${date} ${time}
*/
(3)字段(Fields)注釋標(biāo)簽:
/**
* @Description: ${field} : ${todo}(用一句話(huà)描述這個(gè)變量表示什么)
*/
暫時(shí)用不到
(4)構(gòu)造函數(shù)標(biāo)簽(Constructor):
規(guī)范:
/**
* 構(gòu)造方法的描述
* @param name
* 按鈕的上顯示的文字
*/
Pattern:
/**
* @Description:${todo}
* ${tags}
*/
(5)方法(Methods)標(biāo)簽:(接口和其實(shí)現(xiàn)類(lèi)的方法,都要加注釋?zhuān)?/p>
注釋規(guī)范:
/**
* 為按鈕添加顏色
*@param color
按鈕的顏色
*@return
*@exception (方法有異常的話(huà)加)
* @author Administrator
* @Time 2012-11-20 15:02:29
*/
Pattern:
/**
* @Description:${todo}
* ${tags}
* ${return_type}
* @exception:
* @author: ${user}
* @time:${date} ${time}
*/
(6)覆蓋方法(Overriding Methods)標(biāo)簽:
(7)代表方法(Delegate Methods)標(biāo)簽:
(8)getter方法標(biāo)簽:
(9)setter方法標(biāo)簽:
這些暫時(shí)沒(méi)有定義,可以按照自己的方式添加注釋。
- PC官方版
- 安卓官方手機(jī)版
- IOS官方手機(jī)版