小九九 发表于 2023-8-1 16:38:38

Java注释

在Java语言中,注释是用来对代码进行解释和说明的文本,编译器会忽略注释部分,不会将其视为可执行的代码。注释可以提高代码的可读性,并且方便其他开发人员理解和维护代码。

Java语言中的注释主要分为三类:单行注释、多行注释和文档注释。

1. 单行注释:以双斜线(//)开头,从斜线后开始到行尾结束,用于在单行中添加注释。

   示例:
   ```java
   int age = 18; // 定义年龄变量并赋值为18
   ```

2. 多行注释:以斜线和星号(/*)开头,以星号和斜线(*/)结束,用于在多行中添加注释。

   示例:
   ```java
   /*
   这是一个多行注释示例
   用于对一段代码块进行注释解释
   */
   int x = 10;
   int y = 20;
   ```

3. 文档注释:以斜线和两个星号(/**)开头,以星号和斜线(*/)结束,用于生成API文档。文档注释是一种特殊的注释形式,可以通过工具生成程序的文档。

   示例:
   ```java
   /**
    * 这是一个方法的文档注释示例
    * 该方法用于计算两个数的和
    *
    * @param a 第一个数
    * @param b 第二个数
    * @return 两个数的和
    */
   public int calculateSum(int a, int b) {
       return a + b;
   }
   ```

通过使用注释,可以更好地解释代码的意图、功能和用法,使其他开发人员更易于理解和使用。同时,在编写程序时,良好的注释习惯也能帮助自己更好地理清思路和代码结构。因此,在编写Java代码时,建议合理使用注释并保持良好的注释风格。

页: [1]
查看完整版本: Java注释