言語編

コメント (Comments)

Dartは単行と複行のコメント及びドキュメンテーション・コメントに対応している。

単行コメント(single line comment)

単行コメント(single line comment)はトーケン//で始まる。//とその行の終わりまでの総てはDartのコンパイラは無視する。

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

複行コメント(multi-line comment)

複行コメント(multi-line comment)はトーケン/*で始まりトーケン*/で終わる。/*と*/の間はそのコメントがドキュメンテーション・コメントでない限りなんでもDartのコンパイラは無視する。複行コメントはネスト（入れ子に）できる。これはプログラム開発時に部分的に不要なコメントが含まれているブロックをコメントを使って一時的に隠すのに便利である。

void main() {
  /*
   * This is a lot of work. Consider raising chickens.
  Llama larry = Llama();
  larry.feed();
  larry.exercise();
  larry.clean();
   */
}

ドキュメンテーション・コメント(documentation comments)

ドキュメンテーション・コメント(documentation comments)はトーケン/**または///で始まる単行または複行のコメントである。ドキュメンテーション・コメントの内側では、Dartのコンパイラはそれが括弧で囲まれていない限り総てのテキストを無視する。///を使った行からなるコメントは複行docコメントと同じ効果を持つ。

ドキュメンテーション・コメント内では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) {
    // ...
  }
}

生成されたドキュメンテーションの中で、[Food]はFoodクラスのためのAPI docsへのリンクとなる。Dartコードを解析してHTMLドキュメンテーションを生成するにはSDKのドキュメンテーション生成ツールが使える。Dartのドキュメンテーション法とHTMLドキュメンテーション・ツールを参照されたい。