1、背景简介

丰富的注释和良好的代码规范，对于代码的阅读性和可维护性起着相当重要的做用。几乎每一个公司对这的要求仍是比较严格的，每每会造成本身的一套编码规范。可是再实施过程当中，若是全靠手动完成，不只效率低下，还难以保证真正的符合规范。因此结合IDE环境，自动生成注释，仍是颇有必要的。今天咱们就说一下，如何使用Eclipse给咱们提供的自定义代码模版的功能来做业。java

2、设置注释模板

• 设置注释模板的入口：Window->Preference->Java->Code Style->Code Templateeclipse

• 而后展开Comments节点就是全部需设置注释的元素了！函数

• 一下修改，只须要点击右侧面板上的按钮 – 编辑(Edit)， 即可修改为本身的注释！编码

  
  

  这里写图片描述

3、详细介绍

一、文件(Files)注释标签

Files标签是对新建的文件的说明，出如今文件最上面spa

• 推荐注释风格：

/** * Copyright © ${year} eSunny Info. Tech Ltd. All rights reserved. * * 功能描述： * @Package: ${package_name} * @author: ${user} * @date: ${date} ${time} */

二、类型(Types)注释标签（类的注释）

Types标签是对类Class的一个说明，出如今类上面.net

• 推荐注释风格：

/** * Copyright: Copyright (c) ${year} LanRu-Caifu * * @ClassName: ${file_name} * @Description: 该类的功能描述 * * @version: v1.0.0 * @author: ${user} * @date: ${date} ${time} * * Modification History: * Date Author Version Description *---------------------------------------------------------* * ${date} ${user} v1.0.0 修改缘由 */

三、字段(Fields)注释标签

Fields标签是对变量字段的说明代码规范

• 推荐注释风格：

// @Fields ${field} : ${todo}

四、构造函数(Constructors)标签

Constructors标签是对类的构造函数的说明code

• 推荐注释风格：

/** * @Function: ${file_name} * @Description: 该函数的功能描述 * * @param:参数描述 * @version: v1.0.0 * @author: ${user} * @date: ${date} ${time} */

五、方法(Methods)标签

Methods标签是对函数方法的说明blog

• 推荐注释风格：

/** * @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 修改缘由 */

六、覆盖方法(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 修改缘由 */

七、表明方法(Delegate Methods)标签

• 推荐注释风格：

/** * ${tags} * ${see_to_target} */

八、getter方法标签

• 推荐注释风格：

/** * @return the ${bare_field_name} */

九、setter方法标签

• 推荐注释风格：

/** * @param ${param} the ${bare_field_name} to set */

4、如何自动添加注释

一、可经过以下三种方法自动添加注释：

• 输入“/**”并回车。
• 用快捷键 Alt＋Shift+J（先选中某个方法、类名或变量名）。
• 在右键菜单中选择“Source > Generate ElementComment”。

二、新建文件或类的时候，怎么自动生成文件(file)的注释呢？

只须要勾选Automatically and comments for new methods and types便可！

三、导入/导出代码格式模板

若是你辛辛苦苦定制好了本身的代码风格，而后换了台机器进行操做或重装了Eclipse，是否是要从新配置一遍呢？答案固然是No了，Eclipse提供了“导出”和“导入”功能，你能够把本身的模板导出来在其余机器上使用。

5、建立自定义注释模板

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