Java 注释主要有三种类型:单行注释、多行注释和文档注释。这些注释可以帮助程序员增强代码的可读性,并提供对代码功能和逻辑的解释说明。
### 1. 单行注释
单行注释以双斜线 `//` 开始,可以用于在一行内注释单行代码或语句。
```java
int age = 30; // 定义变量 age,并赋值为 30
```
单行注释也可以放在代码行的末尾:
```java
System.out.println("Hello, World!"); // 输出 Hello, World!
```
### 2. 多行注释
多行注释以 `/*` 开始,以 `*/` 结束,用于注释多行代码或大段注释。
```java
/*
* 这是一个多行注释的示例。
* 在这里可以写多行文字作为注释。
* 多行注释可以跨越多行代码,用于详细解释代码的功能和逻辑。
*/
int x = 5;
int y = 10;
int sum = x + y; // 计算 x 和 y 的和
```
### 3. 文档注释
文档注释以 `/**` 开始,以 `*/` 结束,通常用于为类、方法、字段等提供详细的说明文档。文档注释支持特殊的标记,如 `@param`、`@return` 等,用于生成文档。
```java
/**
* 这是一个简单的Java类,用于演示文档注释的使用。
* 它包含一个成员变量和一个方法。
*/
public class MyClass {
private int value; // 这是一个成员变量,用于存储整数值
/**
* 这是一个用于设置值的方法。
* @param newValue 设置的新值
*/
public void setValue(int newValue) {
this.value = newValue;
}
/**
* 这是一个用于获取值的方法。
* @return 当前存储的值
*/
public int getValue() {
return this.value;
}
}
```
文档注释中的 `@param` 标记用于说明方法参数,`@return` 标记用于说明方法返回值,还可以使用 `@throws` 标记说明可能抛出的异常等。
### 总结
- **单行注释**:用 `//` 开始,用于单行注释。
- **多行注释**:用 `/* */` 包围多行文本,用于大段注释或注释多行代码。
- **文档注释**:用 `/** */` 包围,用于生成文档,并支持特殊标记以提供详细的文档说明。
注释在Java编程中是非常重要的,能够帮助他人理解你的代码,也有助于自己在日后维护和修改代码时的思路清晰。