注释 - Comments

Dart 支持单行注释、多行注释和 文档注释。

Single-line comments 单行注释以 // 开始。 // 后面的一行内容 为 Dart 代码注释。

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

Multi-line comments

多行注释以 /* 开始， */ 结尾。 多行注释 可以 嵌套。

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

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

Documentation comments

文档注释可以使用 /// 开始， 也可以使用 /** 开始 并以 */ 结束。

在文档注释内， Dart 编译器忽略除了中括号以外的内容。 使用中括号可以引用 classes、 methods、 fields、 top-level variables、 functions、 和 parameters。中括号里面的名字使用 当前注释出现地方的语法范围查找对应的成员。

下面是一个引用其他类和成员 的文档注释：

/// A domesticated South American camelid (Lama glama).
///
/// Andean cultures have used llamas as meat and pack
/// animals since pre-Hispanic times.
class Llama {
  String name;

  /// Feeds your llama [Food].
  ///
  /// The typical llama eats one bale of hay per week.
  void feed(Food food) {
    // ...
  }

  /// Exercises your llama with an [activity] for
  /// [timeLimit] minutes.
  void exercise(Activity activity, int timeLimit) {
    // ...
  }
}

在生成的文档中，[Food] 变为一个连接 到 Food 类 API 文档的链接。

使用 SDK 中的 文档生成工具可以解析文档并生成 HTML 网页。 关于生成的文档示例，请参考 Dart API 文档。 关于如何 组织文档的建议，请参考 Dart 文档注释指南。