跳到主要內容

元資料

使用元資料為程式碼提供額外資訊。元資料註解以字元 @ 開頭,後跟對編譯時常量(如 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');
}

元資料可以出現在庫、類、類型別名、型別引數、建構函式、工廠、函式、欄位、引數或變數宣告之前,以及匯入或匯出指令之前。