C#のコメントの書き方ガイド!1行・複数行コメントの基本と使い分け
生徒
「C#のコードにメモを残す方法ってあるんですか?」
先生
「ありますよ!C#では『コメント』を使って、コードに説明を書いたり、メモを残したりできます。」
生徒
「そのコメントって、プログラムの動作には関係ないんですか?」
先生
「はい、コメントはあくまで開発者のためのメモなので、実際のプログラムには影響しません。では、基本から見ていきましょう!」
1. コメントとは?プログラムに書けるメモ
C#のコメントとは、プログラムの中に書かれた説明文やメモのことで、実際の動作には一切関係しません。コードの意味を忘れないようにするために、あとで読み返したときに「このコードは何をしているのか」がわかるようにする目的で使われます。
例えば、料理のレシピの中に「ここでは強火で炒める」とメモするようなイメージです。それがコメントです。
2. C#のコメントの基本書き方
コメントには大きく分けて「1行コメント」と「複数行コメント」の2種類があります。
3. 1行コメント(シングルラインコメント)の使い方
1行コメントは、//
(スラッシュを2つ)を使って書きます。この//
より後ろの文章は、すべてコメントとして扱われます。
コードの横や、コードの上に説明をつけるときによく使われます。
// これは1行コメントです
Console.WriteLine("こんにちは"); // あいさつを表示する
4. 複数行コメント(ブロックコメント)の使い方
複数行のコメントを書きたいときには、/*
から始まり、*/
で終わる形で書きます。この間にあるすべての文章がコメントになります。
/*
ここは複数行のコメントです。
複数行にわたってメモを書きたいときに便利です。
*/
Console.WriteLine("複数行コメントの後");
まるで、手紙のように長い文章を丁寧に書きたいときに使えます。
5. 1行コメントと複数行コメントの使い分け方
次のような場合で使い分けましょう:
- 短い説明やメモ →
//
(1行コメント) - 長めの説明や複数の注意点 →
/* */
(複数行コメント)
たとえば、1行だけの意味を説明したいときは次のようにします。
// 年齢を表示する
Console.WriteLine("年齢:20歳");
逆に、処理の流れや注意点をまとめて書くときは複数行が向いています。
/*
この部分は重要な処理です。
データベースとの接続を行っています。
接続エラーに注意が必要です。
*/
ConnectToDatabase();
6. コメントはプログラムに影響しない
初心者が不安になるポイントのひとつが、「コメントを書いたらプログラムに影響が出るのでは?」という点です。
しかし安心してください。コメントはあくまで“無視される”部分です。たとえば、次のコードではコメント部分は実行されず、Console.WriteLine
だけが実行されます。
// この行は何も実行されません
Console.WriteLine("実行されるのはこの行だけです");
実行されるのはこの行だけです
7. コメントの注意点と便利な使い方
コメントには便利な使い方もありますが、いくつか注意点もあります。
- 書きすぎに注意:コメントが多すぎると逆に読みづらくなります。
- 古いコメントに注意:コードを変更したら、コメントも更新しましょう。
- コードを一時的に無効にする:動かしたくないコードをコメントアウトして保留にできます。
例として、次のように一時的にコードをコメントアウトすることで、動作を確認できます。
// Console.WriteLine("この行は今は表示しません");
Console.WriteLine("この行だけ表示されます");
この行だけ表示されます
8. よくある質問(初心者向けQ&A)
Q1. コメントって英語で書かないとダメ?
A1. いいえ、日本語で書いて大丈夫です。自分や他の人がわかりやすい言葉で書くのがベストです。
Q2. コメントに絵文字とか記号を使ってもいいの?
A2. 基本的にはOKですが、プログラミングの環境によっては文字化けすることがあるので、シンプルな文字が安心です。
Q3. コメントを書くときのコツは?
A3. 将来の自分や他の人が見ても「なるほど」と思えるように、なぜそのコードを書いたのか、どんな目的かを書くと良いです。