:::info 引用自https://www.cnblogs.com/HaveChen/p/11451354.html :::

定义

用于注解说明解释程序的文字
Java的注释信息是给程序员看的，编译器(javac)在编译的时候会忽略掉源文件中的注释信息。

三种类型

:::info 快捷键默认指Eclipse的快捷键 :::

单行注释

快捷键Ctrl+/
再次按撤销注释
一般用来注释局部变量。
Java注释以及规范 - 图1

多行注释

快捷键：Ctrl+shift+/ 撤销Ctrl+shift+\
可用来注释文件头、算法实现、方法中的复杂代码块、修改记录
Java注释以及规范 - 图2

文档注释

可用来注释类、接口、静态方法、成员方法、静态变量、成员变量、常量

快捷键：shift+alt+j
或者在定义完：注释类、接口、静态方法、成员方法、静态变量、成员变量、常量后，在上面加上/**在按Enter建也能生成

Enter键之后

修改文档注释的方法
修改文档注释的注释格式内容，修改的方法有两种：

A.直接在eclipse给的模板下进行修改
打开Eclipse
Window —> Preferences —> Java —> Code Style —> Code Templates —> Comments —> types —> Edit…

例如：
Java注释以及规范 - 图5

/**   
　　　　* 项目名称：${project_name}   
　　　　* 类名称：${type_name}   
　　　　* 类描述：   
　　　　* 创建人：${user}   
　　　　* 创建时间：${date} ${time}   
　　　　* @version        
　　　　*/

B.自己编写一个xml文档导入进去

打开Eclipse
Window —> Preferences —> Java —> Code Style —> Code Templates —> Comments —> types —> Import…
选择你写好的模板.xml文件

常见注释

类注释

在每个类前面加上类注释，注释内容包括类或接口名，类和接口功能描述，作者，创建日期，所属公司、版本等：
Ecplice在/+Enter自动生成相关信息设置：

属性，方法等等自动生成相应的注解也是在此设置；
具体的可以参考：[Eclipse代码模板设置**](https://www.yuque.com/wumingdejing/fikq0y/95ebef9d-f69b-4c09-86fc-0306517075f0)