Java注釋模板設置

eclipse中設置Java注釋模板

eclipse設置注釋模板的入口：?Window->Preference->Java->Code Style->Code Template然后展開Comments節點就是所有需設置注釋的元素啦

Java注釋模板標簽語法

標簽

作用域

說明

@author

類

標明開發該類模塊作者

@version

類

標明該類模塊的版本

@see

類, 屬性, 方法

參考轉向(相關主題)

@param

方法

對方法中某參數的說明

@return

方法

對方法返回值的說明

@exception

方法

拋出的異常類型

@throws

方法

與@exception相同

@deprecated

方法

不建議使用該方法

注釋模板例子

文件(Files)注釋標簽

/**

* @Title: ${file_name}

* @Package ${package_name}

* @Description: ${todo}

* @author A18ccms A18ccms_gmail_com

* @date ${date} ${time}

* @version V1.0

*/

類型(Types)注釋標簽(類的注釋)

/**

* @ClassName: ${type_name}

* @Description: ${todo}

* @author A18ccms a18ccms_gmail_com

* @date ${date} ${time}

*

* ${tags}

*/

字段(Fields)注釋標簽

/**

* @Fields ${field} : ${todo}

*/

構造函數標簽

/**

*

Title:

*

Description:

* ${tags}

*/

方法(Constructor & Methods)標簽

/**

* @Title: ${enclosing_method}

* @Description: ${todo}

* @param ${tags}????設定文件

* @return ${return_type}????返回類型

* @throws

*/

覆蓋方法(Overriding Methods)標簽

/* (非?Javadoc)

*

Title: ${enclosing_method}

*

Description:

* ${tags}

* ${see_to_overridden}

*/

代表方法(Delegate Methods)標簽

/**

* ${tags}

* ${see_to_target}

*/

getter方法標簽

/**

* @return ${bare_field_name}

*/

setter方法標簽

/**

* @param ${param}?要設置的?${bare_field_name}

*/

版權聲明：本文為JAVASCHOOL原創文章，未經本站允許不得轉載。

總結

以上是生活随笔為你收集整理的java注释模板_Java注释模板设置的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。