Java 中的注释

在 Java 中，注释是为了增加代码可读性和可维护性而添加的。注释是写给人看的，而不是写给计算机执行的指令。

Java 中有三种注释类型：单行注释、多行注释和文档注释。

单行注释

单行注释以 // 开头，对其后的一条语句进行注释。注释只占一行，一般用于简单易懂的语句。

// 这是一个单行注释
int age = 18; // 年龄赋值为18

多行注释

多行注释以 /* 开头，以 */ 结尾，可以注释多行代码或注释一整个方法。多行注释一般用于详细的解释和说明。

/*
这是一个多行注释，
可以注释多行代码，
或注释一整个方法。
*/
public void doSomething() {
    /*
    这是一个详细的注释，
    解释该方法的功能和参数。
    */
    int result = 1 + 1; // 计算结果为2
}

文档注释

文档注释以 /** 开头，以 */ 结尾，用于生成 API 文档。文档注释一般放在类、接口、构造函数、方法上，描述其作用、参数、返回值等信息。

/**
 * 这是一个演示类，
 * 用于演示 Java 中的注释。
 */
public class CommentDemo {

    /**
     * 这是一个演示方法，
     * 用于演示 Java 中的三种注释。
     * @param name 姓名
     * @return 返回问候语
     */
    public String sayHello(String name) {
        // 这是一个单行注释
        /* 这是一个多行注释 */
        return "Hello, " + name + "!";
    }
}

总结

Java 中的注释是为了增加代码的可读性和可维护性而添加的。单行注释以 // 开头，多行注释以 /* 开头，文档注释以 /** 开头。文档注释用于生成 API 文档，注释是写给人看的。在编写程序时，要注意添加注释，使得代码更加清晰易懂。