注釋

單行注釋

單行注釋以 // 開始。 所有在 // 和改行結(jié)尾之間的內(nèi)容被編譯器忽略。

void main() {
  // TODO: refactor into an AbstractLlamaGreetingFactory?
  print('Welcome to my Llama farm!');
}

多行注釋

多行注釋以 /* 開始， 以 */ 結(jié)尾。 所有在 /* 和 */ 之間的內(nèi)容被編譯器忽略 （不會忽略文檔注釋）。 多行注釋可以嵌套。

void main() {
  /*
   * This is a lot of work. Consider raising chickens.

  Llama larry = Llama();
  larry.feed();
  larry.exercise();
  larry.clean();
   */
}

文檔注釋

文檔注釋可以是多行注釋，也可以是單行注釋， 文檔注釋以 /// 或者 /** 開始。 在連續(xù)行上使用 /// 與多行文檔注釋具有相同的效果。

在文檔注釋中，除非用中括號括起來，否則Dart 編譯器會忽略所有文本。 使用中括號可以引用類、 方法、 字段、 頂級變量、 函數(shù)、 和參數(shù)。 括號中的符號會在已記錄的程序元素的詞法域中進(jìn)行解析。

下面是一個引用其他類和成員的文檔注釋：

/// A domesticated South American camelid (Lama glama).
///
/// 自從西班牙時代以來，
/// 安第斯文化就將駱駝當(dāng)做肉食類和運(yùn)輸類動物。
class Llama {
  String name;

  /// 喂養(yǎng)駱駝 [Food].
  ///
  /// 典型的美洲駝每周吃一捆干草。
  void feed(Food food) {
    // ...
  }

  /// 使用 [activity] 訓(xùn)練駱駝
  /// [timeLimit] 分鐘。
  void exercise(Activity activity, int timeLimit) {
    // ...
  }
}

在生成的文檔中，[Food] 會成為一個鏈接， 指向 Food 類的 API 文檔。