有關eclipse的代碼註釋

網上的Eclipse註釋模板,在這裡稍稍整理一些比較常用的。

編輯註釋模板的方法:Window->Preference->Java->Code Style->Code Template

Comments節點就是所有需設置註釋的元素啦。這裡介紹一些常用的:

1.文件(Files)註釋標籤:

/** 
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句話描述該文件做什麼)
* @author:
* @date: ${date} ${time}
* @version V1.0
*/

2.類型(Types)註釋標籤(類的註釋):

/**

* @ClassName: ${type_name}

* @Description:${todo}(這裡用一句話描述這個類的作用)

* @author:

* @date: ${date} ${time}

* ${tags}

*/

3.字段(Fields)註釋標籤:

/** 
* @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)
*/

4.構造函數標籤:

/** 
* @Title: ${enclosing_type}
* @Description: ${todo}(這裡用一句話描述這個方法的作用)
* @param: ${tags}
* @throws
*/

5.方法(Methods)標籤:

/** 
* @Title: ${enclosing_method}
* @Description: ${todo}(這裡用一句話描述這個方法的作用)
* @param: ${tags}
* @return: ${return_type}
* @throws
*/

6.覆蓋方法(Overriding Methods)標籤:

/** 
*

Title: ${enclosing_method}


*

Description:


* ${tags}
* ${see_to_overridden}
*/

其他的默認就行了


分享到:


相關文章: