网上的Eclipse注释模板,在这里稍稍整理一些比较常用的。
编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:
1.文件(Files)注释标签:
/**
* @Description: ${todo}(用一句话描述该文件做什么)
* @Title: ${file_name}
* @Package ${package_name}
* @author: 佳云科技有限责任公司:XXX
* @date: ${date} ${time}
* @version V1.0
* 注意:本内容仅限于武汉佳云科技有限责任公司内部传阅,禁止外泄以及用于其他的商业目
* @Copyright: ${year} www.jiayunkeji.com Inc. All rights reserved.
* All rights Reserved, Designed By www.jiayunkeji.com
*/
2.类型(Types)注释标签(类的注释):
/**
* @Description:${todo}(这里用一句话描述这个类的作用)
* @ClassName: ${type_name}
* @author: 佳云科技有限责任公司:XXX
* @date: ${date} ${time}
* ${tags}
* 注意:本内容仅限于武汉佳云科技有限责任公司内部传阅,禁止外泄以及用于其他的商业目
* @Copyright: ${year} www.jiayunkeji.com Inc. All rights reserved.
*/
3.字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
4.构造函数标签:
/**
* @Title: ${enclosing_type}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param: ${tags}
* @throws
*/
5.方法(Methods)标签:
/**
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @Title: ${enclosing_method}
* @param: ${tags}
* @return: ${return_type}
* @throws
* @date: ${date} ${time}
*/
6.覆盖方法(Overriding Methods)标签:
/**
*
Title: ${enclosing_method}
*
Description:
* ${tags}
* ${see_to_overridden}
*/
7.代表方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/
8.getter方法标签:
/**
* @Title: ${enclosing_method}
* @Description: please write your description
* @return: ${field_type}
*/
9.setter方法标签:
/**
* @Title: ${enclosing_method}
* @Description: please write your description
* @return: ${field_type}
*/