Dart入門！コメントの種類と書き方についてわかりやすく解説！

前回のDart入門記事はこちら！

コメントとは

コメントとはコードの中に自由に記載できるメモのようなものです！
プログラムが動く際にコメントは無視されるので、何の処理をしているかなどの注釈を残すことができます。後から見返したり、他の人が見てもわかりやすくするため非常に重要な機能です！

コメントは他のプログラミング言語にもありますが、Dartにももちろんついています！

Dartのコメントの種類

Dartのコメントには主に3種類存在します。

1行コメント

一行だけコメントを入れる場合は「//」を書き、その後ろにコメントを書きます。
その行のみコメントという扱いになります。

// この行はコメントです。

実際にDartで書いてみるとこんな感じです。

実行すると以下のようになります。

出力された結果にコメントが反映されていないことがわかりますね。

複数行コメント

一行だけでなく、複数行にわたってコメントを書くこともできます。
その場合は「/*」から始まり「*/」で終わる書き方で、その間に入力したものはコメント扱いになります。

/* ここはコメント
ここもコメント
これまたコメント */

こちらもDartで書いた場合とその結果が下の画像のようになります。

コメント部分がちゃんと無視された結果になっていますね。

ドキュメントコメント

ドキュメンテーションコメントともいいます。
メソッドなどの処理のまとまりに対して、どんな内容の処理をするかを書き、ドキュメント化ができるコメントの書き方です。当然コメントの一種なので結果には反映されません。

書き方は「///」を書きます。するとそれに続く1行はドキュメントコメントになります。

/// これはドキュメントコメントです。
///
/// 1行目に概要、2行目は空けて3行目以降に詳細を書きます。
/// [hoge]のようにプロパティは角かっこでくくるといい感じにドキュメント化してくれます。
/// サンプルコードなんかも書いたりします。
/// マークダウン記法も使えます。サンプルコードはマークダウン記法で書くことが推奨されています。

実際にDartで書いてみるとこんな感じです。

Dartをインストールしていれば「dartdoc」コマンドでdartファイルを指定するとドキュメントを作ってくれます！

コメントをつけてわかりやすいコーディングをしよう！

次回のDart入門記事はこちら！