先生と生徒の会話形式で理解しよう

生徒

「C#のコメントって、ただのメモですか？使い方がよく分かりません…」

先生

「コメントはプログラムに説明を加えるためのものですが、実はそれだけじゃありません。『TODO』や『FIXME』といった便利な使い方もありますよ。」

生徒

「それってどういう意味ですか？使い方を教えてください！」

先生

「それでは、初心者の方にもわかるように、コメントの書き方と活用方法を順番に解説していきましょう。」

1. コメントとは？

プログラミングでいう「コメント」とは、コンピュータに無視される文章のことです。つまり、プログラムの動作には影響せず、人間が読むためのメモや説明文として使います。初心者の方は「プログラムにひとこと添えるふせん」くらいのイメージでOKです。

C#ではコメントの書き方に以下の2つがあります。

// コメント：1行だけのコメント
/* コメント */：複数行のコメント


// これは1行コメントです

/* 
これは複数行にまたがる
コメントです 
*/

2. TODOコメントとは？

TODOコメントは「あとでやること」を記録するために使います。たとえば、まだ実装していない処理や、後で追加したい機能などを書いておくことで、忘れずに作業できます。

TODOは大文字で書くのが一般的で、Visual Studioなどの開発ツールでは、自動で目立つように表示してくれます。


// TODO: ボタンをクリックしたときの処理を追加する

これは「今はまだ処理を書いていないけれど、あとで必ず書く予定」という意味です。

3. FIXMEコメントとは？

FIXMEコメントは「直す必要がある場所」に使います。「今は動いてるけど、あとで問題になりそう」なコードに使われます。


// FIXME: この部分はエラーになる可能性があるので後で修正

「フィックスミー」と読みます。直訳すると「私を修正して！」という意味で、バグや仮のコードに目印をつけておくのに便利です。

4. ドキュメンテーションコメントとは？

「ドキュメンテーションコメント」とは、プログラムの説明書のようなものです。特にメソッド（処理のまとまり）に説明をつけるときに使います。書き方は /// を使います。


/// <summary>
/// 2つの数を足し算するメソッドです。
/// </summary>
/// <param name="a">1つ目の数字</param>
/// <param name="b">2つ目の数字</param>
/// <returns>足し算の結果</returns>
int Add(int a, int b)
{
    return a + b;
}

このように書くと、マウスをコードに合わせたときに説明がポップアップで表示されるようになります。

5. コメントを使うと何が良いの？

コメントを使うと、自分の考えを記録できるだけでなく、他の人が読んだときにも理解しやすくなります。

例えば、大工さんが作った家具に「ここはネジをゆるめると分解できます」とメモがあったら分かりやすいですよね？それと同じで、プログラムにも「ここで○○をしています」と書いておくと、読みやすくなります。

特にチーム開発や、将来自分が見返すときに役立ちます。

6. コメントを使ったサンプルコード

ここまでの学習をふまえて、実際のコード例を見てみましょう。


using System;

class Program
{
    static void Main()
    {
        // ユーザーの名前を入力
        Console.WriteLine("名前を入力してください：");
        string name = Console.ReadLine();

        // TODO: 入力チェックを追加する
        Console.WriteLine("こんにちは、" + name + "さん！");

        // FIXME: 名前が空のときの対応が必要
    }

    /// <summary>
    /// 挨拶を出力するメソッド
    /// </summary>
    /// <param name="name">ユーザーの名前</param>
    static void Greet(string name)
    {
        Console.WriteLine("こんにちは、" + name + "さん！");
    }
}