java日常学习之注释

Java 注释是用于向程序中添加说明性文字的一种方式，它可以帮助程序员理解和维护代码，也可以提高代码的可读性和可维护性
Java 支持三种注释方式

单行注释：以 // 开始，从//开始一直到行尾都被视为注释，编译器会忽略这部分内容。单行注释通常用来对代码进行简短的解释或者临时禁用一行代码。只能注释一行代码或者对附近的代码进行说明。示例：

int x = 10; // 这是声明一个整数变量并赋值

多行注释：以 /* 开始，以 */ 结束，可以注释多行代码。之间的内容都被视为注释。多行注释通常用于对较长的代码块进行注释说明。示例：

/*
这是
多行
注释
*/

文档注释：以 /** 开始，以 */ 结束，可以用于生成文档的注释，通常用来为类、方法或字段生成文档。文档注释中可以使用一些特殊的标签，如 @param, @return, @see 等，来描述类、方法、参数、返回值等信息，这些标签能够被一些工具解析，生成程序的文档。示例：

/**
 * 这是一个简单的Java类
 */
public class MyClass {
    /**
     * 这是一个简单的方法
     * @param x 参数x
     * @return 返回参数的平方
     */
    public int square(int x) {
        return x * x;
    }
}

Java 中的注释不会影响程序的执行结果，也不会被编译器编译成字节码。但是，文档注释可以被 javadoc 工具软件读取，生成 HTML 格式的 API 文档1。文档注释对于生成API文档非常有用，通过工具如Javadoc可以自动生成基于文档注释的程序文档，使其他开发人员能够更容易地了解代码的结构和功能。

Java 中的不同类型的注释的快捷键

单行注释：选中区域+alt+/ 取消注释同样是这个快捷键

多行注释：选中区域+Ctrl+shift+/ 取消注释是选中区域+Ctrl+shift+\

文档注释：alt+shift+j