元数据

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

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

class Television {
  /// 使用 [turnOn] 代替打开电源。
  @Deprecated('Use turnOn instead')
  void activate() {
    turnOn();
  }

  /// 打开电视电源。
  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');
}

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

除非另有说明，否则本网站上的文档反映的是 Dart 3.6.0。页面最后更新于 2025-02-05。 查看源代码 或 报告问题.