Dart注释

Dart语言详解

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

单行注释

单行注释以//开头。Dart 编译器会忽略// 和行末之间的所有内容。

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

多行注释

多行注释以/*开头并以*/结尾。 Dart 编译器会忽略/*和*/之间的所有内容（除非注释是文档注释；请参阅下一节）。多行注释可以嵌套。

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

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

文档注释

文档注释是多行或单行注释，以///或开头/**。在连续的行上使用///具有与多行文档注释相同的效果。

在文档注释中，分析器会忽略所有文本，除非文本括在括号中。使用括号，您可以引用类、方法、字段、顶级变量、函数和参数。括号中的名称在记录的程序元素的词法范围内解析。

以下是引用其他类和参数的文档注释的示例：

/// A domesticated South American camelid (Lama glama).
///
/// Andean cultures have used llamas as meat and pack
/// animals since pre-Hispanic times.
///
/// Just like any other animal, llamas need to eat,
/// so don't forget to [feed] them some [Food].
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) {
    // ...
  }
}

在类的生成文档中，[feed]成为方法文档的链接feed，并[Food]成为类文档的链接Food。

解析 Dart 代码并生成 HTML 文档，您可以使用 Dart 的文档生成工具。dart doc