Java核心技术卷1 开发基础第3章 Java的基本程序设计结构 3.2 注释

矫情吗；* 2024-03-16 14:25 18阅读 0赞

#### Java核心技术卷1 开发基础 ####

#### 文章目录 ####

*   *   *  Java核心技术卷1 开发基础
         *   *  第3章 Java的基本程序设计结构
             *   *  3.2 注释

![在这里插入图片描述][72a5b6a3edc741deac6a90dac9179b12.png_pic_center]

##### 第3章 Java的基本程序设计结构 #####

###### 3.2 注释 ######

在Java 中有3 种标记注释的方式

*  `//`：注释内容从`//`开始到本行结尾。
 *  `/* */`：多行注释，需要注意的是在Java中，`/* */`不能嵌套
 *  `/** */`：文档注释，可以自动生成文档【后面还会说到】

/**
     * This is the first sample program in Core Java Chapter 3
     *
     * @author Gary Cornell
     * @version 1.01 1997-03-22
     */
    public class FirstSample {
        
        public static void main(String[] args) {
        
            System.out.println("We will not use 'Hello, World!'");
    
            // 单行注释
            
            /*
            多行
            注释
            哈哈
             */
    
        }
    }

![在这里插入图片描述][2cf4c39e07824240a14afc1968f12782.png_pic_center]

注释不会影响程序的执行

![在这里插入图片描述][3e7a47177cfc4c569cca52ebe725eaad.png_pic_center]

`ChatGPT`：

在Java中，注释是用于解释和说明代码的文本块。注释不会被编译器解析或执行，它们只是对代码的解释和说明。Java中有三种类型的注释：

1.  **单行注释**: 单行注释以双斜杠（`//`）开头，从双斜杠后的字符直到该行的末尾都被视为注释。单行注释通常用于对代码的某个特定部分进行短暂的解释或注解。

// 这是一个单行注释
    int x = 10; // 这是一个对变量x的注释

1.  **多行注释**: 多行注释以斜杠星号（`/*`）开头，以星号斜杠（`*/`）结尾。多行注释可以跨越多行，并且可以用于对较长的代码块进行注释或在代码中添加详细的说明。

/* 这是一个多行注释
       它可以跨越多行并提供详细的说明 */
    int x = 10;

1.  **文档注释**: 文档注释（也称为Javadoc注释）是一种特殊的注释形式，用于生成文档和API文档。文档注释以斜杠星号（/\*\*）开头，以星号斜杠（\*/）结尾。文档注释通常用于对类、方法、字段等进行详细的描述，并可以生成可读性强的文档。

/**
     * 这是一个文档注释，用于描述该类的功能和用法
     */
    public class MyClass {
        
        /**
         * 这是一个方法的文档注释
         * @param x 参数x的说明
         * @return 返回值的说明
         */
        public int myMethod(int x) {
        
            // 方法体
            return x;
        }
    }

文档注释中还可以使用一些特殊的标签（如@param、@return等），用于提供方法参数、返回值等的说明和描述，这些标签在生成文档时会被解析和呈现。

注释在Java中对于代码的可读性和维护性非常重要。良好的注释能够帮助其他开发人员理解代码的意图、功能和用法，并且在以后的维护和修改过程中提供有价值的指导。

[72a5b6a3edc741deac6a90dac9179b12.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/cddff97108d1493ba83d9de3f5734200.png
[2cf4c39e07824240a14afc1968f12782.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/de27b2e0fb4c47dea1667dc0fcab3866.png
[3e7a47177cfc4c569cca52ebe725eaad.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/678ff74951544aefb0e02215780c12c3.png