Skip to content

元数据(Metadata)
使用元数据可以为代码提供附加信息。元数据注解以字符@开头,后接编译时常量引用(如deprecated)或常量构造函数调用。

所有Dart代码均可使用以下四种注解:@Deprecated、@deprecated、@override和@pragma。关于@override的使用示例,请参见《扩展类》。以下是使用@Deprecated注解的示例:

dart
class Television {
  /// 使用[turnOn]方法来开启电源
  @Deprecated('改用turnOn方法')
  void activate() {
    turnOn();
  }

  /// 开启电视电源
  void turnOn() {
    ...
  }
  // ···
}

若无需指定提示信息,可使用@deprecated注解。但建议始终为@Deprecated提供说明信息。

您可以自定义元数据注解。以下是定义带两个参数的@Todo注解示例:

dart
class Todo {
  final String who;
  final String what;

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

以下是使用@Todo注解的示例:

dart
@Todo('Dash', '实现此函数')
void doSomething() {
  print('执行操作');
}

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