设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。
例如我们希望在一个Java文件的开头设置作者作者信息以及日期信息:
选择Types(类型),点击右边的按钮Edit(编辑),将
/**
* @author ${user}
* ${tags}
*/
中 的“${user}”删除,改成**(你想自动生成的名字信息,例如张三),这样作者信息就变成*(张三)了;点击Insert Variable(插入变量)按钮,选择Date,这样就会自动生成日期信息,同时你还可以再插入时间。设置完以后我们测试一下,自动生成的注释信息为:
/**
* @author 张三
* 2010-4-8下午11:12:05
*/
调出注释快捷键
Alt + Shfit + J
把光标的焦点放在方法名或类名上
然后再按下Alt + Shfit + J ,就OK了!!
现就每一个元素逐一介绍:
文件(Files)注释标签:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author A18ccms A18ccms_gmail_com
* @date ${date} ${time}
* @version V1.0
*/
类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author A18ccms a18ccms_gmail_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}
*/