好的注释可以增加代码的可读性,因此代码注释就非常重要了,下面为个人常用的一份eclipse模板
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素
模板如下:
文件(Files)注释标签:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* @author ${user}
* @date ${date}
* @version V1.0
*/
类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description: ${todo}
* @author ${user}
* @date ${date}
*
* ${tags}
*/
字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}
*/
构造方法(Constructor)标签:
/**
* ${enclosing_type}.
*
* ${tags}
*/
方面标签
/**
* @Title: ${enclosing_method}
* @Description: ${todo}
* @param ${tags}
* @return ${return_type}
* @throws
*/
覆盖方法标签
/*
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法(Delegate Methods)标签
/**
* ${tags}
* ${see_to_target}
*/
getters 方法
/**
* @return ${bare_field_name}
*/
setters 方法
/**
* @param ${param} the ${bare_field_name} to set
*/
参考:
Eclipse添加注释