元数据(注释)

Last updated: ... / Reads: 43 Edit

使用元数据提供有关代码的附加信息。元数据注释以字符 @ 开头,后跟对编译时常量(例如 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');
}

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


Comments

Make a comment