注释是对java源代码的解释说明，可以帮助程序员更好的理解程序。
注释信息只保存在java源文件当中，java源文件编译生成的字节码class文件是没有注释的。
编写注释是每一个程序员的基本素养，特别是在多人协作的复杂项目中，注释比命重要，宁多不少，尽量做到言简意赅。
在Java中，常用的注释分为三种：文档注释、多行注释、单行注释。
文档注释
/**
* @author 阿pin
* @date 2022/2/10
* @description HelloWorld
*/
public class HelloWorld {
}
文档注释通常位于程序的开头，以 /** 开始，以 */ 结束，用于对该程序作用的描述，也用于对类、变量和方法的描述。若在IDEA中配置过，文档注释可自动配置开发人员、开发时间、开发背景等，对于之后的程序维护有很重要的作用。
多行注释
/**
* @param args 参数
*/
public static void main(String[] args) {
System.out.println("Hello World");
}
/**
* 两个值取最大值
* @param param1 参数1
* @param param2 参数2
* @return 返回最大值
*/
public int returnTest(int param1,int param2) {
return Math.max(param1,param2);
}
多行注释和文档注释写法相同，多用于方法说明、参数说明、返回值说明。多行注释有预览模式，预览便于阅读，如下图：
除了对方法进行相关说明外，也可以用来引用其他程序。
/**
* The mothod {@link Test#testFunction()}
*
* @see #testMethod()
*/
private void testLink() {
Test.testFunction();
testMethod();
}
private void testMethod() {
}
当调用其他方法不管是本类的，还是其他类的均可以进行说明。
@Deprecated
public final class Test {
public static void testFunction() {
}
}
引用后的程序字体有明显的不同，点击会有相关说明，同时Ctrl+Enter或Command+Enter点击进入相关程序。当类或方法或变量被@Deprecated标记后，表示已过时，引用的时候会在中间画横线。除此之外注释还有其他标签供使用。
| 标签 | 描述 |
|---|---|
| @author | 作者 |
| @deprecated | 过期 |
| @exception | 异常 |
| {@link} | 插入一个到另一个主题的链接 |
| @param | 参数 |
| @return | 返回值类型 |
| @see | 指定一个到另一个主题的链接 |
| @since | 标记变化 |
| @version | 版本 |
| {@value} | static常量 |
| @throws | 抛异常 |
| @serialField | ObjectStreamField组件 |
| @serialData | 通过writeObject( ) 和 writeExternal( )方法写的数据 |
| @serial | 序列化属性 |
| {@linkplain} | 插入一个到另一个主题的链接，但以纯文本显示该链接 |
| {@inheritDoc} | 从父类继承的注释 |
| {@docRoot} | 当前文档根目录路径 |
单行注释
public static void main(String[] args) {
// 输出Hello World到控制台
System.out.println("Hello World");
}
单行注释以 // 开头，只能标记一行，用于对具体代码语句进行说明
