网上的Eclipse注释模板,在这里稍稍整理一些比较常用的。
编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:
1.文件(Files)注释标签:
/**
* All rights Reserved, Designed By www.tydic.com
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author: 刘星哲
* @date: ${date} ${time}
* @version V1.0
* @Copyright: ${year} www.tydic.com Inc. All rights reserved.
* 注意:本内容仅限于深圳天源迪科信息技术股份有限公司内部传阅,禁止外泄以及用于其他的商业目
*/
2.类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description:${todo}(这里用一句话描述这个类的作用)
* @author: 刘星哲
* @date: ${date} ${time}
* ${tags}
* @Copyright: ${year} www.tydic.com Inc. All rights reserved.
* 注意:本内容仅限于深圳天源迪科信息技术股份有限公司内部传阅,禁止外泄以及用于其他的商业目
*/
3.字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
4.方法(Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @author 刘星哲
* @date ${date} ${time}
* @param ${tags} 设定文件
* @return ${return_type} 返回类型
* @throws
*/