元数据
使用元数据为代码提供额外信息。元数据注解以字符 @
开头,后跟对编译时常量(如 deprecated
)的引用或对常量构造函数的调用。
所有 Dart 代码都可使用四种注解:@Deprecated
、@deprecated
、@override
和 @pragma
。有关使用 @override
的示例,请参阅继承类。以下是使用 @Deprecated
注解的示例
dart
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
注解的示例
dart
class 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');
}
元数据可以出现在库、类、类型别名、类型参数、构造函数、工厂、函数、字段、参数或变量声明之前,以及导入或导出指令之前。