eclipse修改默认注释

【eclipse修改默认注释】

一、背景简介
丰富的注释和良好的代码规范，对于代码的阅读性和可维护性起着至关重要的作用。几乎每个公司对这的要求还是比较严格的，往往会形成自己的一套编码规范。但是再实施过程中，如果全靠手动完成，不仅效率低下，还难以保证真正的符合规范。所以结合IDE环境，自动生成注释，还是很有必要的。今天我们就说一下，如何使用Eclipse给我们提供的自定义代码模版的功能来作业。

二、设置注释模板
设置注释模板的入口：Window->Preference->Java->Code Style->Code Template
然后展开Comments节点就是所有需设置注释的元素了！
一下修改，只需要点击右侧面板上的按钮 – 编辑(Edit)，便可修改成自己的注释！
eclipse修改默认注释
三、详细介绍
1、文件(Files)注释标签
Files标签是对新建的文件的说明，出现在文件最上面
推荐注释风格：
/**

功能描述：
@Package: ${package_name}
@author: ${user}
@date: ${date} ${time}
/
2、类型(Types)注释标签（类的注释）
Types标签是对类Class的一个说明，出现在类上面
推荐注释风格：
/*
@ClassName: ${file_name}
@Description: 该类的功能描述
@version: v1.0.0
@author: ${user}
@date: ${date} ${time}
Modification History:
Date Author Version Description
---------------------------------------------------------
${date} ${user} v1.0.0 修改原因
/
3、字段(Fields)注释标签
Fields标签是对变量字段的说明
推荐注释风格：
// @Fields ${field} : ${todo}
4、构造函数(Constructors)标签
Constructors标签是对类的构造函数的说明
推荐注释风格：
/*
@Function: ${file_name}
@Description: 该函数的功能描述
@param:参数描述
@version: v1.0.0
@author: ${user}
@date: ${date} ${time}
/
5、方法(Methods)标签
Methods标签是对函数方法的说明
推荐注释风格：
/*
@Function: ${file_name}
@Description: 该函数的功能描述
@param:描述1描述
@return：返回结果描述
@throws：异常描述
@version: v1.0.0
@author: ${user}
@date: ${date} ${time}
Modification History:
Date Author Version Description
---------------------------------------------------------
${date} ${user} v1.0.0 修改原因
/
6、覆盖方法(Overriding Methods)标签
Overriding Methods标签是对覆盖方法的说明
推荐注释风格：
/*
${see_to_overridden}
@Function: ${file_name}
@Description: 该函数的功能描述
@param:描述1描述
@return：返回结果描述
@throws：异常描述
@version: v1.0.0
@author: ${user}
@date: ${date} ${time}
Modification History:
Date Author Version Description
---------------------------------------------------------
${date} ${user} v1.0.0 修改原因
/
7、代表方法(Delegate Methods)标签
推荐注释风格：
/*
${tags}
${see_to_target}
/
8、getter方法标签
推荐注释风格：
/*
@return the ${bare_field_name}
/
9、setter方法标签
推荐注释风格：
/*
@param ${param} the ${bare_field_name} to set
*/
四、如何自动添加注释
1、可通过如下三种方法自动添加注释：
输入“/**”并回车。
用快捷键 Alt＋Shift+J（先选中某个方法、类名或变量名）。
在右键菜单中选择“Source > Generate ElementComment”。
2、新建文件或类的时候，怎么自动生成文件(file)的注释呢？

只需要勾选Automatically and comments for new methods and types即可！
3、导入/导出代码格式模板
如果你辛辛苦苦定制好了自己的代码风格，然后换了台机器进行操作或重装了Eclipse，是不是要重新配置一遍呢？答案当然是No了，Eclipse提供了“导出”和“导入”功能，你可以把自己的模板导出来在其他机器上使用。

五、创建自定义注释模板
eclipse自带一些注释模板，如日期(@date)、文件名(@ClassName)、作者(@author)等，那么怎么自定义一些注释模板呢？

已设置已导出的附件