173. Java 注释 - 注释应用场景:类、字段、方法等

173. Java 注释 - 注释应用场景:类、字段、方法等

🎯 注释可以应用于声明

Java 中,注释可以用于各种声明,例如类、字段、方法以及其他程序元素。通常,注释会单独占用一行,并位于需要描述的元素上方。例如:

java 复制代码
// 这是一个描述类的注释
class MyClass { 
    // 这里是字段注释
    private int myField;

    // 这是方法注释
    public void myMethod() { 
        // 方法实现
    }
}

📝 Java SE 8 新增的功能:类型注释

Java SE 8 开始,Java 允许将注释应用于类型的使用,这被称为类型注释。类型注释可以用来增强代码的可读性,甚至为工具和框架提供更多的上下文信息。这使得注释不仅限于类、字段和方法的声明,还可以精确到类型本身。

以下是一些常见的类型注释使用场景:

1. 类实例创建表达式

类型注释可以直接作用于类实例创建时。例如,如果你想要标注类 MyObject 的实例为 @Interned,你可以像下面这样写:

java 复制代码
new @Interned MyObject();

在这个例子中,@Interned 是一个自定义注释,用于标识 MyObject 的实例应该满足特定的要求(例如,表明这个对象是"常驻"的,可能不会频繁地被回收)。

2. 强制转换

类型注释还可以应用于强制转换(类型转换)表达式中。这有助于为转换提供更多上下文信息。例如,你可以在强制转换中标明某个对象不允许为 null

java 复制代码
myString = (@NonNull String) str;

在这个例子中,@NonNull 注释用于确保 str 被强制转换为 String 时,转换后的对象不能为 null

3. implements 子句

类型注释也可以用于 implements 子句,这对于标注泛型类型的约束非常有用。例如:

java 复制代码
class UnmodifiableList<T> implements
    @Readonly List<@Readonly T> { ... }

在这个例子中,@Readonly 注释用于表示 UnmodifiableList 类实现了一个只读的列表接口,并且列表的元素也是只读的。这样,使用者可以清楚地看到,这个类及其字段的内容不能被修改。

4. 抛出异常声明

在方法的声明中,你还可以将注释应用于抛出的异常类型。这有助于提高代码的可读性,并标明该方法抛出的异常有特殊意义。例如:

java 复制代码
void monitorTemperature() throws
    @Critical TemperatureException { ... }

在这个例子中,@Critical 注释表示 TemperatureException 是一个关键异常,可能需要特殊的处理或关注。这种注释有助于开发者在阅读代码时,快速理解异常的重要性。

📌 结论

  • 类型注释Java SE 8 引入的新特性,允许你在类、字段、方法等声明之外,进一步标注类型信息。
  • 通过使用类型注释,你可以增强代码的可读性、准确性和表达能力,尤其是在泛型、强制转换和异常处理等复杂场景中。
  • 类型注释不仅限于标准库,也可以与自定义注释一起使用,提供更多上下文信息,帮助代码审查和自动化工具的处理。
相关推荐
想用offer打牌14 小时前
MCP (Model Context Protocol) 技术理解 - 第二篇
后端·aigc·mcp
崔庆才丨静觅14 小时前
hCaptcha 验证码图像识别 API 对接教程
前端
passerby606115 小时前
完成前端时间处理的另一块版图
前端·github·web components
KYGALYX15 小时前
服务异步通信
开发语言·后端·微服务·ruby
掘了15 小时前
「2025 年终总结」在所有失去的人中,我最怀念我自己
前端·后端·年终总结
崔庆才丨静觅15 小时前
实用免费的 Short URL 短链接 API 对接说明
前端
崔庆才丨静觅16 小时前
5分钟快速搭建 AI 平台并用它赚钱!
前端
爬山算法16 小时前
Hibernate(90)如何在故障注入测试中使用Hibernate?
java·后端·hibernate
崔庆才丨静觅16 小时前
比官方便宜一半以上!Midjourney API 申请及使用
前端
Moment16 小时前
富文本编辑器在 AI 时代为什么这么受欢迎
前端·javascript·后端