Java注释——课后笔记（java的注释怎么写）

Java注释主要有三种类型：单行注释、多行注释、文档注释

1、单行注释以双斜杠开始，比如：

//这是单行注释
int x = 30; // 初始化一个变量x为30

2、多行注释以/*开始，以*/结束，比如：

/*
这是一个多行注释
可以用来注释多行代码
*/
int y = 60; // 初始化一个变量y为60

3、文档注释以 /** 开始，以 */ 结束。通常出现在类、方法、字段等的声明前面，用于生成代码文档，这种注释可以被工具提取并生成 API 文档，如 JavaDoc

/**
 * 这是一个文档注释示例
 * 它通常包含有关类、方法或字段的详细信息
 */
public class MyClass {
    // 类的成员和方法
}

文档注释的格式通常包含一些特定的标签，如 @param 用于描述方法参数，@return 用于描述返回值，@throws 用于描述可能抛出的异常等等，这些标签有助于生成清晰的API文档，以便其他开发者能够更好地理解和使用你的代码。