在敲代码时,添加注释是我们不可或缺的一项习惯。而Eclipse自带的注释往往不能满足我们的需求,所以我们需要修改Eclipse默认的注释模版,以符合自己公司的代码注释规范。
修改注释模版这件事情,百度一下就会找到很多篇相关的博客。
一般的方法就是:
打开 window–>Preferences–>Java–>Code Style–>Code Templates–>Comments 然后对Files,Types,Mthods等模版逐一修改。
模版如下:
File(文件):
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author 十期-牛迁迁
* @date ${date} ${time}
* @version V1.0
*/
Types(类型):
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author: 十期-牛迁迁
* @date: ${date} ${time}
* ${tags}
*/
字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
方法(Constructor & Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param: ${tags}
* @return: ${return_type}
* @author: 十期-牛迁迁
* @date: ${date} ${time}
* @throws
*/
极简方法:
但是这种方法太麻烦了,我找到了一种特别简单的配置方法:
1、下载此模板: codetemplates.xml
2、然后将模版中的【牛迁迁】,替换成你自己的姓名,保存。
3、打开Eclipse/MyEclipse
选择 window–>Preferences–>Java–>Code Style–>Code Templates–>Comments
点击右边的Import ,选择你写好的模板codetemplates.xml 文件,导入进去即可。
最后测试:
在这里科普一个Eclipse快捷键:Shift+Alt+J ,注释快捷键。
希望能够帮助到大家。以前还写过一个VS的注释模版配置:头文件注释轻松搞—VS2013 可参考。