元数据

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

所有 Dart 代码可以使用四个注释：@Deprecated、@deprecated、@override 和 @pragma。有关使用 @override 的示例，请参见 扩展类。以下是如何使用 @Deprecated 注释的示例

class 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` 注释的示例

class Todo {
  final String who;
  final String what;

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

以下是如何使用 `@Todo` 注释的示例

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

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

除非另有说明，否则本网站上的文档反映了 Dart 3.5.3。页面最后更新于 2024-04-08。 查看源代码 或 报告问题.