##**介绍**
>为了提高代码的可读性以及为了有些代码有洁癖的人的需求,我们要从学生到职业进行迈进的过程中,必须把以前的那种代码可读性不高的习惯改掉,因为我们必须要与企业接轨..
>好了,废话不多说,反正就是提升自己的代码可读性,为了以后自己查阅或者其他人查看都有良好的体验。
##**前期准备及部署**
>设置注释模板的入口:**Window->Preference->Java->Code Style->Code Template** 然后展开Comments节点就是所有需设置注释的元素。本文现就每一个元素逐一给大家介绍一下。
![](https://img2018.cnblogs.com/blog/1232151/201908/1232151-20190806185638461-1250125280.png)
一共有这么多的代码注释可选项
1.Files
```
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author ${user}
* @date ${date}
* @version V1.0
*/
```
2.Types
```
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author Anxc
* @date ${date}
*
* ${tags}
*/
```
3.Fields
```
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
```
4.Constructors
```
/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/
```
5.Methods
```
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 参数
* @return ${return_type} 返回类型
* @throws
*/
```
6.Overriding methods
```
/* (非 Javadoc)
* Title: ${enclosing_method}
* Description:
* ${tags}
* ${see_to_overridden}
*/
```
7.Delegate methods
```
/**
* ${tags}
* ${see_to_target}
*/
```
Getters和Setters
一般不做设置,我觉得没啥用。
##添加注释方法
* 输入“/**”并回车。
* 用快捷键 Alt+Shift+J(先选中某个方法、类名或变量名)。
* 在右键菜单中选择“Source > Generate ElementComment
##参考链接
[Eclipse注释模板设置详解](https://www.cnblogs.com/fan-yuan/p/5152965.html)
[Eclipse的自动添加注释和导入导出注释模板](https://blog.csdn.net/qq_36186690/article/details/82505525)