如何在Eclipse中如何自动添加注释和自定义注释风格

设置注释模板

设置注释模板的入口：Window->Preference->Java->Code Style->Code Template ，然后展开Comments节点就是所有需设置注释的元素了！ 这里写图片描述 接下来，对每一个元素逐一介绍：

• 文件(Files)注释标签

Files标签是对新建的文件的说明，出现在文件最上面

举栗子：

/**

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

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

Types标签是对类Class的一个说明，出现在类上面

举栗子：

/**

• @ClassName: ${type_name}
• @Description: ${todo}
• @author: ${user}
• @date: ${date} ${time}
• ${tags} */

• 字段(Fields)注释标签

Fields标签是对变量字段的说明

举栗子：

// @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)

• 构造函数(Constructors)标签

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

举栗子：

/**

• @Title:${enclosing_type}
• @Description:${todo}
• ${tags} */

• 方法(Methods)标签

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

举栗子：

/**

• @Title: ${enclosing_method}
• @Description: ${todo}
• ${tags} ${return_type}
• @author ${user}
• @date ${date}${time} */

• 覆盖方法(Overriding Methods)标签

Overriding Methods标签是对覆盖方法的说明

举栗子：

/* (non Javadoc)

• @Title: ${enclosing_method}
• @Description: ${todo}
• ${tags}
• ${see_to_overridden} */

• 代表方法(Delegate Methods)标签

举栗子：

/**

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

• getter方法标签

举栗子：

/**

• @return ${bare_field_name}
  */

• setter方法标签

举栗子：

/**

• @param ${param} 要设置的 ${bare_field_name}
  */

以上标签，只需要点击右侧面板上的按钮 – 编辑(Edit)， 便可修改成自己的注释！ 如何自动添加注释

可通过如下三种方法自动添加注释：

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

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

只需要勾选Automatically and comments for new methods and types即可！

导入/导出代码格式模板

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

创建自定义注释模板

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

转载地址：https://blog.csdn.net/changqing5818/article/details/51996302