有关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}
*/

其他的默认就行了


分享到:


相關文章: