java中的文件注释文档注释代码注释分别怎么写

在 Java 中，有三种常见的类型的注释用于文件、方法和代码：

1. **文件注释** (Javadoc-style comments)：通常位于源文件的顶部，用于提供关于整个包或模块的描述。例如：

/**
 * 这是一个说明文档。
 *
 * @author YourName
 * @version 1.0
 */
public class MyClass {
...
}

使用 `/**` 开始，`*/` 结束，可以包含标签如 `@author`, `@version`, 等。

2. **方法注释** (Method-level Javadoc): 对每个方法定义前的注释，描述方法的功能、输入参数、返回值等。示例：

/**
 * 计算两个数的和
 * 
 * @param a 第一个加数
 * @param b 第二个加数
 * @return 返回两数之和
 */
public int add(int a, int b) {
   ...
}

3. **代码注释** (Inline comments or single-line comments): 单行注释用 `//` 开头，用于临时解释某一行代码的作用；而多行注释通常用于复杂逻辑块内部：

int result = 0; // 初始化结果变量
// 如果a大于b，则交换它们的值
if (a > b) {
    int temp = a;
    a = b;
    b = temp;
}

记得保持注释简洁明了，有助于他人理解和维护代码。同时，遵守 JavaDoc 的规范对于生成 API 文档非常关键。