【自学Java】Java注释

Love The Way You Lie 2024-03-30 13:14 10阅读 0赞

## Java注释 ##

### Java注释教程 ###

用于注解说明解释程序的文字就是注释，注释可以提高代码的阅读性。同时，注释也是一个程序员必须要具有的良好的编程习惯。我们首先应该将自己的思想通过注释先整理出来，再用代码实现。

在 **Java 语言** 中，一旦程序中某部分内容被注释掉，则该内容就会被 Java 语言解释器忽视，换句话说，此部分内容将不会被执行。

### Java语言注释作用 ###

注释不仅可以用来解释程序某些部分的作用和功能（用自然语言描述代码的功能），在必要时，还可以将代码临时移除，是调试程序的好帮手。

通常而言，合理的代码注释应该占源代码的 1/3 左右。

### Java语言注释形式 ###

Java 提供了两种注释的形式，即行注释和块注释。

#### 行注释 ####

##### 定义 #####

Java 语言的行注释用于注释一行代码，且可以嵌套使用。

##### 语法 #####

// 注释内容

##### 说明 #####

我们用 `//` 注释了一行代码。

#### 块注释(多行注释) ####

##### 定义 #####

Java 语言的块注释用于注释多行代码，同时，也可以注释一行代码，且不可以嵌套使用。

##### 语法 #####

/**
     *  注释内容
     */

##### 说明 #####

我们使用了斜杠加星号的块注释，注释了块代码。

### 案例 ###

#### Java语言行注释 ####

Java 语言行注释只能够用来注释单行代码

package com.haicoder;
    
    public class HelloWorld {
        
        public static void main(String[] args) {
        
            System.out.println("嗨客网（www.haicoder.net）\n");
            //System.out.println("我来试试行注释开始");
            System.out.println("Hello World");
            //System.out.println("我来试试行注释结束");
        }
    
    }

运行效果如下：

![请添加图片描述][770625fa8a4540108877c47d8cddfef6.png]

我们可以看到，在代码中我们调用 `System.out.println` 这个语句调用了三次，第一次和第三次我们注释掉了，所以结果只打印一次。

#### Java语言块注释 ####

Java 语言块注释可以注释行代码

package com.haicoder;
    
    public class HelloWorld {
        
        public static void main(String[] args) {
        
            System.out.println("嗨客网（www.haicoder.net）\n");
            /**
             *   System.out.println("我来试试块注释开始");
             */
            System.out.println("Hello World");
    
            /**
             * System.out.println("我来试试块注释结束");
             * */
        }
    
    }

控制台输出如下：

![请添加图片描述][27f5eba52890495d88937b7ca46e7840.png]

我们可以看到在代码中我们调用 `System.out.println` 这个语句调用了三次，第一次和第三次我们注释掉了，所以结果只打印一次。

#### Java语言块注释 ####

Java 语言块注释可以注释多行代码

package com.haicoder;
    
    public class HelloWorld {
        
        public static void main(String[] args) {
        
            System.out.println("嗨客网（www.haicoder.net）\n");
            /**
             *   System.out.println("我来试试块注释开始");
             *   System.out.println("我来试试块注释结束");
             */
            System.out.println("Hello World");
    
        }
    
    }

控制台输出如下：

![请添加图片描述][529b04b91c1740d5b6d28c39deb8c192.png]

我们可以看到在代码中我们调用 `System.out.println` 这个语句调用了三次，第一次和第三次我们注释掉了，所以结果只打印一次。

### Java语言注释总结 ###

Java 语言注释分为单行注释和块注释，其中单行注释可以嵌套，块注释不可以嵌套。

[770625fa8a4540108877c47d8cddfef6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/c78fa5bac74c45359e78604105a87d7b.png
[27f5eba52890495d88937b7ca46e7840.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/fbecb3c3279f443c9e4df05924d6c588.png
[529b04b91c1740d5b6d28c39deb8c192.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/001b50d9be7340d48be6b84afe4937ad.png