java基础知识（4）—代码注释及注释快捷键

在计算机语言中，注释是计算机语言的一个重要组成部分，用于在源代码中解释代码的作用，可以增强程序的可读性，可维护性。

Java 注释是一种在 Java 程序中用于提供代码功能说明的文本。

注释不会被编译器包含在最终的可执行程序中，因此不会影响程序的运行。

注释是良好的编程习惯，它们帮助程序员更容易地理解代码的用途和功能，并且在团队协作中非常有用。

Java 注释主要有三种类型：

• 单行注释
• 多行注释
• 文档注释

1. 单行注释（Single-line Comment）

在 Java 中，单行注释以 // 开头，从 // 开始直到该行结束的所有内容都被视为注释。单行注释主要用于对某一行代码或一小段代码进行简要的说明。

例如：

// 定义一个整数变量 num 并初始化为 5
int num = 5; 
// 以下代码计算 num 的平方
int square = num * num; 

2. 多行注释（Multi-line Comment）

多行注释以 /* 开头，以 */ 结尾。在这对符号之间的所有内容都是注释，可以跨越多行。多行注释常用于对一段较长的代码块、方法或类进行较为详细的解释。

例如：

/*
  这个方法用于计算两个整数的和
  参数 num1 和 num2 分别表示要相加的两个整数
  返回值为两数之和
*/
public int add(int num1, int num2) {
    return num1 + num2;
}

3. 文档注释（Documentation Comment）

文档注释以 /** 开头，以 */ 结尾。文档注释通常用于为类、方法、变量等生成详细的文档说明。这些注释包含特定的格式和标签，以便工具（如 Javadoc 工具）能够将其提取并生成格式良好的 HTML 文档。

常见的标签包括：

• @author：指定作者信息。
• @version：指定版本号。
• @param：描述方法的参数。
• @return：描述方法的返回值。
• @throws：描述方法可能抛出的异常。

例如：

/**
 * 这个类表示一个学生
 * 
 * @author John Doe
 * @version 1.0
 */
public class Student {

    /**
     * 学生的姓名
     */
    private String name;

    /**
     * 构造函数，用于初始化学生的姓名
     * 
     * @param name 学生的姓名
     */
    public Student(String name) {
        this.name = name;
    }

    /**
     * 获取学生的姓名
     * 
     * @return 学生的姓名
     */
    public String getName() {
        return name;
    }
}

在一些常见的 Java 集成开发环境（IDE）中，常见的注释快捷键如下：

• IntelliJ IDEA：

  • 单行注释：Ctrl + /
  • 多行注释：Ctrl + Shift + / （取消注释：Ctrl + Shift + \ ）

• Eclipse：

  • 单行注释：Ctrl + /
  • 多行注释：Ctrl + Shift + / （取消注释：Ctrl + Shift + \ ）

• NetBeans：

  • 单行注释：Ctrl + /
  • 多行注释：Ctrl + Shift + / （取消注释：Ctrl + Shift + \ ）

良好的注释习惯能够极大地提高代码的可读性和可维护性，使其他开发者更容易理解您的代码意图和逻辑。