自己记录代码备注习惯。
首先是设置注释模板的入口位置:
Window->Preference->Java->Code Style->Code Template
然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:
一、文件(Files)注释标签:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* @author Luoyuze shuaiqiaze@163.com
* @date ${date} ${time}
*/
二、类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description: ${todo}
* @author Luoyuze shuaiqiaze@163.com
* @date ${date} ${time}
*
* ${tags}
*/
三、字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}
*/
四、构造函数标签:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
五、方法(Constructor & Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 设定文件
* @return ${return_type} 返回类型
* @throws
*/
六、覆盖方法(Overriding Methods)标签:
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
七、代表方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/
八、getter方法标签:
/**
* @return ${bare_field_name}
*/
九、setter方法标签:
/**
* @param ${param} 要设置的 ${bare_field_name}
*/