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