Java如何让你的电脑崩溃得更优雅些之之注释

第一课：Java中的注释
Java中的注释是用于解释代码、提高代码可读性以及生成文档的工具。Java支持三种注释方式：单行注释、多行注释和文档注释。以下是详细的说明和示例：

---

1. 单行注释

单行注释用于注释一行代码或简短的解释。

语法：

// 注释内容

示例：

int age = 25; // 定义一个整型变量age，并赋值为25

特点：
• 以//开头，注释内容直到行尾。
• 适用于简短的解释或临时注释掉一行代码。

---

2. 多行注释

多行注释用于注释多行代码或较长的解释。

语法：

/*
注释内容
*/

示例：

/*
这是一个多行注释
用于解释以下代码的功能
*/
int a = 10;
int b = 20;
int sum = a + b;

特点：
• 以/*开头，以*/结尾，可以跨越多行。
• 适用于注释掉一段代码或详细的解释。

---

3. 文档注释

文档注释用于生成API文档，通常用于类、方法或字段的解释。

语法：

/**
 * 注释内容
 */

示例：

/**
 * 这是一个计算两个整数和的方法
 * @param a 第一个整数
 * @param b 第二个整数
 * @return 返回两个整数的和
 */
public int add(int a, int b) {
    return a + b;
}

特点：
• 以/**开头，以*/结尾。
• 支持标签（如@param、@return等），用于生成详细的API文档。
• 使用javadoc工具可以从文档注释生成HTML格式的API文档。

---

代码实例

/**
 * 2025年3月16日
 * 作者：陈建顺
 * 这是一个简单的Java程序，用于演示注释的使用
 */

// 这是一个单行注释
public class nhu {

    /*
     * 这是一个main方法
     * main方法是程序的入口方法
     * 所有的程序执行都是从main方法开始
     */
    public static void main(String[] args) {
        // 输出"你好世界"到控制台
        System.out.println("你好世界");
    }
}

---

拓展

1. 注释的作用

• 解释代码：帮助开发者理解代码的功能和逻辑。
• 调试代码：临时注释掉部分代码，方便调试。
• 生成文档：通过文档注释生成API文档，供其他开发者使用。

2. 注释的最佳实践

• 及时更新注释：当代码修改时，确保注释也同步更新。
• 避免过度注释：只注释必要的部分，避免冗余。
• 使用文档注释：为公共类、方法和字段添加文档注释，便于生成API文档。

3. 生成API文档

使用javadoc工具可以从文档注释生成HTML格式的API文档。

命令：

javadoc -d doc -author -version nhu.java

说明：
• -d doc：指定生成的文档存放目录为doc。
• -author：包含作者信息。
• -version：包含版本信息。

结果：
在doc目录下生成HTML格式的API文档，可以通过浏览器查看。

---

总结

注释类型	语法	适用场景	特点
单行注释	// 注释内容	简短的解释或临时注释	单行，简洁
多行注释	/* 注释内容 */	注释多行代码或较长的解释	跨越多行，灵活
文档注释	/** 注释内容 */	生成API文档，解释类、方法或字段	支持标签，可生成HTML文档