11.基础语法-注释

11 注释

11.1 类型

注释：用于在源代码中解释代码，不会被执行。可以增强代码的可读性和可维护性。古人云：“代码未动，注释先行”

1.单行注释
单行注释以双斜杠 // 开始。// 后跟着的当前行（hang）文本被注释（一般注释内容在上方）

// 打印"Hello"到控制台
System.out.println("Hello"); 

2.多行注释
多行注释以 /* 开始，以 */ 结束。注释内可以包含多行文本。

/*
    这一段入门案例代码
    演示如何用输出文本到控制台
    ...
*/
System.out.println("Hello");

3.文档注释
文档注释以 /** 开始，以 */ 结束，注释内可以包含多行文本。通常出现在类、方法、字段等前面。

/**
 *  这是一个文档注释示例
 *  它可以作用在类、方法、字段上
 *  Main是入门案例类
 */
    public class Main {
    // ...    
}  

11.2 演示

11.21 单行注释

快捷键： Ctrl + /

作用：在行首添加或移除 //

// 创建的包, 自动声明
package com.itheima;

// 类也自动声明
public class Main {
    public static void main(String[] args) {  // 输入 main Enter 回车, 自动创建 main 方法
        // 向控制台打印 Hello World!
        System.out.println("Hello World!");  // 输入 sout Enter 回车, 输入 "Hello World!"
    }
}

------------------------------------------------ 执行后
D:\Software\jdk17\bin\java.exe "-javaagent:D:\Software\JetBrainsIntelliJ IDEA 2025.2.4\lib\idea_rt.jar=2091" -Dfile.encoding=UTF-8 -classpath D:\Software\JavaCode\p1-basic\out\production\p1-basic com.itheima.Main
Hello World!

Process finished with exit code 0

11.22 多行注释

快捷键： Ctrl + Shift + /

作用：包裹选中代码为 /* ... */

// 创建的包, 自动声明
package com.itheima;

// 类也自动声明
public class Main {
    public static void main(String[] args) {  // 输入 main Enter 回车, 自动创建 main 方法
        // 向控制台打印 Hello World!
        /*
           向控制台打印 Hello World!
         */
        System.out.println("Hello World!");  // 输入 sout Enter 回车, 输入 "Hello World!"
    }
}

11.23 文档注释

快捷键：/** + 回车

作用：在方法/类上方输入 /** 后按回车，自动生成 Javadoc 模板

// 创建的包, 自动声明
package com.itheima;
/**
 * 这是一个程序的入口类
 */
// 类也自动声明
public class Main {
    /**
     * 程序入口方法，向控制台输出"Hello World!"字符串
     * @param args 命令行参数数组
     */
    public static void main(String[] args) {  // 输入 main Enter 回车, 自动创建 main 方法
        // 向控制台打印 Hello World!
        /*
           向控制台打印 Hello World!
         */
        System.out.println("Hello World!");  // 输入 sout Enter 回车, 输入 "Hello World!"
    }
}

 

———————————————————————————————————————————————————————————————————————————

                                                                                                                         无敌小马爱学习