在 Java 中,注释用于在代码中添加一些解释性的文字,以提供给程序员或其他读者更多的信息。Java 支持三种类型的注释:

1. 单行注释:
单行注释以 // 开始,从 // 开始到行尾的所有内容都被认为是注释。
// 这是一个单行注释
int x = 10; // 这是一条注释

2. 多行注释:
多行注释以 /* 开始,以 */ 结束,之间的所有内容都是注释。
/*
  这是一个多行注释
  可以跨越多行
*/
int y = 20;

3. 文档注释:
文档注释以 /** 开始,以 */ 结束,与多行注释相似,但通常用于生成 API 文档。文档注释可以包含标签(tags),如 @param、@return 等。
/**
 * 这是一个文档注释的例子
 * 用于说明方法的作用
 *
 * @param a 第一个参数
 * @param b 第二个参数
 * @return 两个参数的和
 */
public int add(int a, int b) {
    return a + b;
}

文档注释的好处是它们可以由一些工具自动提取,并生成程序的 API 文档。通常,IDE(集成开发环境)中的自动完成功能也会使用文档注释来提供关于类、方法和字段的信息。

注释在编写代码时是很有用的,它们可以提高代码的可读性,并帮助其他人理解你的代码。当然,过度注释也可能导致代码混乱,因此建议在需要解释时使用注释。


转载请注明出处:http://www.zyzy.cn/article/detail/13460/Java