單行注釋

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

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

多行注釋

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

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

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

文檔注釋

文檔注釋可以是多行注釋?zhuān)部梢允菃涡凶⑨專(zhuān)?文檔注釋以 /// 或者 /** 開(kāi)始。 在連續(xù)行上使用 /// 與多行文檔注釋具有相同的效果。

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

下面是一個(gè)引用其他類(lèi)和成員的文檔注釋?zhuān)?/p>

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

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

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

在生成的文檔中，[Food] 會(huì)成為一個(gè)鏈接， 指向 Food 類(lèi)的 API 文檔。