Java基础-注释

清峰大约 3 分钟

Java基础-注释

概述

注释是Java代码中不可或缺的一部分，它用于解释代码的功能、目的和实现细节，提高代码的可读性和可维护性。本章节将系统梳理Java中的注释类型及使用规范。

知识要点

1. 单行注释

单行注释以//开头，用于解释单行代码的功能：

public class SingleLineCommentDemo {
    public static void main(String[] args) {
        // 定义一个整数变量
        int num = 10;
        
        // 输出变量的值
        System.out.println("num = " + num); // 这是一个行尾注释
    }
}

2. 多行注释

多行注释以/*开头，以*/结尾，用于解释多行代码的功能：

public class MultiLineCommentDemo {
    /*
     * 这是一个多行注释
     * 用于解释下面的方法
     * 该方法用于计算两个数的和
     */
    public int add(int a, int b) {
        return a + b; // 返回两个数的和
    }
}

3. 文档注释

文档注释以/**开头，以*/结尾，用于生成API文档：

/**
 * 这是一个文档注释
 * 用于描述Person类
 */
public class Person {
    /**
     * 人员姓名
     */
    private String name;
    
    /**
     * 人员年龄
     */
    private int age;
    
    /**
     * 构造方法
     * @param name 姓名
     * @param age 年龄
     */
    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }
    
    /**
     * 获取姓名
     * @return 姓名
     */
    public String getName() {
        return name;
    }
    
    /**
     * 设置姓名
     * @param name 姓名
     */
    public void setName(String name) {
        this.name = name;
    }
    
    /**
     * 获取年龄
     * @return 年龄
     */
    public int getAge() {
        return age;
    }
    
    /**
     * 设置年龄
     * @param age 年龄
     */
    public void setAge(int age) {
        this.age = age;
    }
}