コメント | Dart

単一行コメント
複数行コメント
ドキュメントコメント

Dartは、単一行コメント、複数行コメント、およびドキュメントコメントをサポートしています。

単一行コメントは//で始まります。//と行末の間にあるすべてのテキストは、Dartコンパイラによって無視されます。

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

複数行コメントは/*で始まり、*/で終わります。/*と*/の間にあるすべてのテキストは、Dartコンパイラによって無視されます（コメントがドキュメントコメントである場合を除きます。次のセクションを参照してください）。複数行コメントはネストできます。

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

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

ドキュメントコメントは、///または/**で始まる複数行または単一行コメントです。連続した行に///を使用すると、複数行のドキュメントコメントと同じ効果があります。

ドキュメントコメント内では、ブラケットで囲まれていない限り、すべてのテキストはアナライザーによって無視されます。ブラケットを使用して、クラス、メソッド、フィールド、トップレベル変数、関数、およびパラメーターを参照できます。ブラケット内の名前は、ドキュメント化されたプログラム要素の字句スコープで解決されます。

他のクラスと引数への参照を含むドキュメントコメントの例を以下に示します。

dart/// 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を使用できます。生成されたドキュメントの例については、Dart APIドキュメントを参照してください。コメントの構造に関するアドバイスについては、Effective Dart: Documentationを参照してください。

特に明記されていない限り、このサイトのドキュメントはDart 3.5.3を反映しています。ページの最終更新日：2024年2月7日。ソースを表示または問題を報告する。