【C#入門】コメントの書き方を極める|VSCodeでC#を学ぶ

コメント_C#

プログラミングを始めた当初は楽しさと必死に作り込むあまり、自分の書いたコードが何を意味するのかを残していないことがしばしばあります。

そういうコードが多いと、何年も経ってからプログラムを維持改良する際に自分の書いたコードの目的がわからなくなることがあります。また、自分の書いたコードを他の人が手を加えるときにも同じ現象は起きます。
良いプログラマーは他の人が見てもわかりやすいコードを書くことができますよね!

今回はコードにコメントを残す方法を徹底的に解説していきます!
コメントを残すか残さないかで、良いプログラマーなのか否かが決定しますので、プログラミングの習得をしたい方は必ずご覧になってください。

目次

C#には3種類コメントを残す方法がある

C#でコメントを残す方法は以下の3種類があります。それぞれについて説明していきますね!

コメントの書き方
  1. 行末までコメントする方法 (“//”で表現)
  2. 複数行をコメントする方法 (“/* */”で表現)
  3. 関数などの説明にタグを用いる方法 (“///”で表現)

行末までをコメントする

C#ではコメントしたい行の始めに「//」を入力することで行末までコメントアウトすることができます。

Windows, Linux Ctrl + /
macOS Command + /

下の例ですと、// ここにコメントを記載の箇所が全てコメントとなります。

static void Main(string[] args)
{
    Hello(); // ここにコメントを記載
}

複数行をコメントする

先ほどの//でコメントアウトする方法は単一の行には便利ですが、複数行になると結構面倒な作業になります。C#には複数行をまとめてコメントアウトできる方法がありますのでご安心ください。

Windows, Linux Shift + Alt + A
macOS Shift + Option + A

下の例では、/* */で囲まれた箇所が全てコメントアウトされます。

static void Main(string[] args)
{
    /* Hello(); // ここにコメントを記載
    Console.WriteLine(Hello()); */
}

一括で複数行をコメントアウトできるのは便利ですよね?
しかし、便利な反面注意しないといけないところもあります。

すでに「/* */」でコメントアウトしている箇所には使えない

実際に先ほどのコメントアウトしたコードを更に/* */でコメントアウトしてみます。すると、最後の「*/」がコメントとして認識されません

複数行をコメントアウトするときはこの辺りを注意してくださいね。

コメントアウトされない例

関数などの説明に用いるコメント

関数などの説明をするときは引数や戻り値などの意味を残しておきたい場合が多々あります。

そういったときは、XMLとしてコメントを残す方法もあります。
この機能は、有料版のVisual Studioでは標準で付属していますが、VSCodeは拡張機能を追加する必要があります。

C# XML Documentation Comments のインストール

1.VSCodeを起動する

2.Ctrl + Shift + X (Windows, Linux)、あるいはCommand + Shift + X を入力して拡張機能ビューを開く

3.「C# XML Documentation Comment」と入力してインストール

C# XML Documentation Commentのインストール

4.VSCodeを再起動する

ドキュメンテーション コメント(XMLコメント)を入力

C# XML Documentation Commentのインストールが完了したら、ドキュメンテーション コメント(XMLコメント)を入力したい関数の上で///と入力しましょう。

//// <summary>
/// ここに関数の説明を記載
/// </summary>
/// <param name="message">ここに引数の説明を記載</param>
/// <returns>ここに戻り値の説明を記載</returns>
static string Hello(string message)
{
    return "Hello world!";
}

自動的に///のXMLコメントが入力されます。さらに、関数に引数や戻り値がある場合は、paramやreturnsといったタグが追加されて対象の関数に必要な引数や戻り値の説明をすることが可能です。

重要な点としては、別のコード上に先ほどのXMLコメントが追記された関数を使用するときです。下記のようにHello関数にマウスのカーソルを当てるとXMLコメントの中身を参照することができるので、どういった関数なのか簡単に確認することができ、効率よくプログラミングをすることができます。

XMLコメントの表示

まとめ

学生や新卒のエンジニア、プログラミングを始めたばかりの方にとってはコメントの重要性はまだわからないかもしれません。

しかし、私の経験から、コメントをしっかり残しておくことができたプログラムとそうでないプログラムとでは、その後の品質や維持改良の工数に明らかな違いが生じます。ソースコードにコメントを残しておくことで高い品質を維持することができ、良いプログラマーに一歩近づくことができるのです。

今学生の方やエンジニアになられた方はプログラミングする際にコメントを残す習慣を身に着けましょう!

よかったらシェアしてね!

この記事を書いた人

インドア派で体育会系のソフトウェアエンジニアです。
普段はパソコンをしながらコーヒーを飲むのが至福の時間です。
日々の生活を快適にするための情報を随時アップしていきます。

コメント

コメントする

目次
閉じる