1、注释作用
注释可用于解释Java代码,并使其更具可读性。在测试备用代码时,它也可用于阻止执行。
单行注释以两个斜杠(//
)开头。
Java将忽略//
与行结尾之间的所有文本。
本示例在一行代码之前使用单行注释:
例如:
// 注释内容用来解释说明代码 System.out.println("Hello World");
本示例在代码行的末尾使用单行注释:
例如:
System.out.println("Hello World"); // 注释内容用来解释说明代码
2、Java 多行注释
多行注释以/ *
开头,以* /
结尾。
Java将忽略/ *
和* /
之间的任何文本。
本示例使用多行注释(注释块)来解释代码:
例如:
/* 注释内容是用来 * 解释说明代码 */ System.out.println("Hello World");
单行或多行注释
确定使用哪种注释。 通常,我们使用//
进行简短注释,使用/ * * /
进行较长注释。
public class HelloWorld { /* 这是第一个Java程序 * 它将输出 Hello World * 这是一个多行注释的示例 */ public static void main(String[] args){ // 这是单行注释的示例 /* 这个也是单行注释的示例 */ System.out.println("Hello World"); } }
3、 文档注释 (/** ... */)
文档注释用于生成 Javadoc 文档。它以 /**
开始,*/
结束。通常用于类、方法和字段的说明,以便生成 API 文档。
/** * 这是一个计算加法的类 * 该类包含两个整数的加法操作 */ public class Calculator { /** * 计算两个整数的和 * * @param a 第一个整数 * @param b 第二个整数 * @return 两个整数的和 */ public int add(int a, int b) { return a + b; } }