Java注释是平时开发经常使用到的，下面给大家介绍常见的3种Java注释@mikechen
单行注释
单行注释以 // 开始，直到行尾。
如下所示：
// 这是单行注释 int x = 5; // 初始化变量 x
在上面的例子中，// 后面的内容都被视为注释，不会被编译成字节码。
单行注释通常用于解释代码的作用、提供简短的说明或添加临时注释。
多行注释
多行注释以 /* 开始，以 */ 结束，可以跨越多行。
如下所示：
/*
* 这是多行注释的示例
* 它可以跨越多行，用于添加详细的注释
*/
public class Example {
/*
* 这是一个多行注释示例
* 可以用于注释类、方法、成员变量等
*/
public static void main(String[] args) {
/*
* 这是在 main 方法中的多行注释
* 用于解释一系列操作
*/
int x = 5;
System.out.println(x); // 输出 x 的值
}
}
在上面的例子中，/* 和 */ 之间的内容都被视为注释，不会被编译。
多行注释通常用于添加较长的注释说明，可以横跨多个行。
在一些情况下，它也可以用于临时注释掉一块代码。
文档注释
文档注释也是多行注释，但通常用于生成文档，它以 /** 开始，以 */ 结束。
如下所示：
/**
* 这是一个文档注释的示例类。
* 用于演示文档注释的结构和格式。
*
* @author Your Name
* @version 1.0
* @since 2023-01-01
*/
public class Example {
/**
* 这是一个文档注释的示例方法。
* 用于演示文档注释的结构和格式。
*
* @param x 输入参数 x
* @param y 输入参数 y
* @return 返回结果
*/
public int add(int x, int y) {
// 这是一个行内注释
return x + y;
}
}
文档注释通常包含以下几个部分：
- 类注释：
- 类的描述。
- 作者信息。
- 版本号。
- 创建日期。
- 方法注释：
- 方法的描述。
- 参数说明。
- 返回值说明。
文档注释可以通过Java工具如Javadoc生成HTML格式的API文档。
以上就是Java注释的常见3种方式详解，注释在编写代码时非常重要，可以提高代码的可读性和维护性。
mikechen睿哥
10年+一线大厂架构实战经验，就职于阿里、淘宝等一线大厂，操盘多个亿级大厂核心项目。