面向Kotlin与Java开发者的Dart快速入门（十三）注释

Dart的注释用法与Java大体相同。

单行注释

---

final hoge = 0;    // 到行末都是注释内容

多行注释

---

与Java一样/**/

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

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

文档注释

---

使用dartdoc可以生成HTML的API文档。
dartdoc会在IDE智能提示时发挥作用，所以对外暴露的API建议添加文档注释。

Java的文档注释使用/**开头，Dart中同样支持。另外，///的连续多行注释也可以作为文档注释。

/// 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) {
    // ...
  }
}

像Java一样，文档注释中[]会成为一个链接，例如[Food]可以链接到Food类的定义位置。

---

返回首页：Dart入门教程