在 Java 中,有三种常用的注释形式:单行注释、多行注释和文档注释。
1. 单行注释:以双斜线 (`//`) 开始,用于在一行内注释单个语句或说明代码的含义。
java
// 这是一个单行注释
int x = 5; // 初始化变量 x
2. 多行注释:以斜线加星号 (`/*`) 开始,以星号加斜线 (`*/`) 结束,用于注释多行代码或较长的说明。
java
/*
这是一个多行注释
它可以跨越多行,用于注释多个语句或一段代码
*/
int x = 5;
int y = 10;
3. 文档注释:以斜线加星号加两个星号 (`/**`) 开始,以星号加斜线 (`*/`) 结束,用于为类、方法、字段等编写详细的文档说明。文档注释可以通过工具生成文档,如使用 `javadoc` 工具生成 API 文档。
java
/**
* 这是一个文档注释
* 用于对类、方法、字段等进行详细的文档说明
*/
public class MyClass {
/**
* 这是一个方法的文档注释
* @param x 参数 x
* @param y 参数 y
* @return 返回结果
*/
public int add(int x, int y) {
return x + y;
}
}
文档注释使用特殊的标记(`@`)和标记名称,例如 `@param` 用于描述方法的参数,`@return` 用于描述方法的返回值。通过在代码中使用文档注释,可以为其他开发人员提供清晰的代码文档和使用说明。
注意,注释是用于解释代码和提供文档,不会被编译器编译和执行。注释不会对程序的运行产生任何影响,仅供开发人员阅读和理解代码。