在 Java 中,注释是用来对代码进行解释和说明的非执行语句。Java 提供了三种注释方式:单行注释、多行注释和文档注释。
单行注释
单行注释以 //
开头,从 //
开始到行末都会被视为注释内容,不会被编译器执行。单行注释通常用来对代码进行简单的解释或说明。
// 这是一个单行注释 int num = 10; // 定义一个整型变量 num,并赋值为 10
多行注释
多行注释以 /*
开头,以 */
结尾,之间的内容都会被视为注释内容,不会被编译器执行。多行注释通常用来对比较复杂的代码块进行解释或说明。
/* 这是一个多行注释示例 可以跨越多行 用来对一段代码进行详细的解释 */ int sum = 0; // 定义一个整型变量 sum,并初始化为 0
文档注释
文档注释以 /**
开头,以 */
结尾,之间的内容会被提取生成文档。文档注释通常用来对类、方法、变量等进行详细的说明,生成的文档可以通过工具查看。
/** * 这是一个文档注释示例 * 用来对一个类或方法进行详细的说明 */ public class MyClass { // 类的实现 }
在编写 Java 代码时,合理使用注释可以提高代码的可读性和维护性,建议在需要解释或说明代码逻辑时添加适当的注释。