元数据

使用元数据提供有关代码的附加信息。元数据注解以字符 @ 开头，后跟对编译时常量（例如 deprecated）的引用或对常量构造函数的调用。

所有 Dart 代码都可以使用四种注解：@Deprecated、@deprecated、@override 和 @pragma。有关使用 @override 的示例，请参阅扩展类。下面是使用 @Deprecated 注解的示例

dartclass Television {
  /// Use [turnOn] to turn the power on instead.
  @Deprecated('Use turnOn instead')
  void activate() {
    turnOn();
  }

  /// Turns the TV's power on.
  void turnOn() {...}
  // ···
}

如果您不想指定消息，可以使用 @deprecated。但是，我们建议始终使用 @Deprecated 指定消息。

您可以定义自己的元数据注解。下面是一个定义接受两个参数的 @Todo 注解的示例

dartclass Todo {
  final String who;
  final String what;

  const Todo(this.who, this.what);
}

下面是使用该 @Todo 注解的示例

dart@Todo('Dash', 'Implement this function')
void doSomething() {
  print('Do something');
}

元数据可以出现在库、类、类型别名、类型参数、构造函数、工厂、函数、字段、参数或变量声明之前，以及 import 或 export 指令之前。

除非另有说明，本网站上的文档反映的是 Dart 3.6.0。页面上次更新于 2024-11-17。查看源代码或报告问题。