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