C#のコメントアウト完全ガイド｜1行・複数行・解除方法とVisual Studioショートカットを初心者向けに解説
はじめに
C#でプログラミングをしていると、「このコードを一時的に実行されない状態にしたい」「処理内容をメモとして残したい」という場面があります。そこで使われるのが、コメントアウトです。
C#では、//を使って1行をコメントアウトできます。また、コードの行末に補足コメントを書くことも可能です。
この記事では、C#のコメントアウトとは何か、コメントを書く目的、コードを削除する場合との違い、1行コメントの基本的な書き方を初心者向けに解説します。
1. C#のコメントアウトとは？初心者向けに基本を解説
C#のコメントアウトとは、ソースコードの一部をプログラムの実行対象から外すことです。
コメントとして記述された内容は、コード上には残りますが、プログラムの処理には影響しません。そのため、コードの説明を書いたり、一部の処理を一時的に無効化したりする目的で利用されます。
C#では、主に次のような記号を使ってコメントを記述します。
// 1行コメント/*複数行コメント/
//は、記号を記述した位置から行末までをコメントにします。/と*/で囲む方法は、複数行をまとめてコメントにするときに使用します。
本記事では、まず初心者が最初に覚えておきたい//を使った1行コメントを中心に解説します。
1-1. コメントアウトするとコードはどうなる？
コードをコメントアウトすると、その部分はコンパイルや実行の対象から外れます。
たとえば、次のC#コードを見てみましょう。
Console.WriteLine("処理A");Console.WriteLine("処理B");このコードを実行すると、次のように表示されます。
処理A処理B次に、2行目をコメントアウトします。
Console.WriteLine("処理A");// Console.WriteLine("処理B");実行結果は次のとおりです。
処理AConsole.WriteLine("処理B");というコード自体は残っていますが、先頭に//が付いているため実行されません。
このように、コメントアウトを使うと、コードを削除せずに特定の処理だけを一時停止できます。
ただし、コメントの中に書かれたコードは、C#の処理としてチェックされない場合があります。コメントアウトしたまま長期間放置すると、ほかのコードを変更した際に内容が古くなり、コメントを解除しても正常に動かなくなることがあります。
不要なコードを何でもコメントアウトして残すのではなく、一時的な確認に利用することが大切です。
1-2. コメントを書く目的と主な使用場面
C#でコメントを書く目的は、大きく分けて「コードを説明すること」と「処理を一時的に無効化すること」の2つです。
コードの目的や理由を説明する
コメントを使うと、そのコードが何のために存在しているのかを記録できます。
// 消費税を加算した金額を計算するdecimal totalPrice = price * 1.1m;後からコードを読み返したときや、ほかの開発者がコードを確認するときに、処理の意図を理解しやすくなります。
ただし、コードを読めばすぐに分かる内容を、そのままコメントに書く必要はありません。
// priceに1000を代入するint price = 1000;このようなコメントは、コードと同じ内容を言い換えているだけです。コメントには「何をしているか」だけでなく、「なぜその処理が必要なのか」を書くと役立ちます。
// キャンペーン期間中は送料を無料にするshippingFee = 0;一部の処理を一時的に停止する
エラーの原因を調べるときや、動作を比較するときには、特定のコードをコメントアウトして実行対象から外します。
LoadUserData();// SendNotification();SaveLog();この例では、SendNotification();だけが実行されません。
問題のある処理を一時的に停止し、ほかの部分が正常に動くか確認することで、不具合の原因を切り分けやすくなります。
作業中のメモを残す
コメントは、今後対応する内容や注意点を記録するためにも使われます。
// TODO: 入力値のチェック処理を追加する// NOTE: この処理は外部APIの仕様に合わせているTODOは未対応の作業、NOTEは補足事項を示すときによく使われます。
ただし、個人的なメモを大量に残すとコードが読みにくくなります。チーム開発では、コメントの書き方に関するルールを確認しましょう。
1-3. コメントアウトとコード削除の違い
コメントアウトとコード削除は、どちらも対象の処理を実行させない方法ですが、コードを残すかどうかが異なります。
コメントアウトでは、コードをファイル内に残したまま実行対象から外します。
// Console.WriteLine("テストメッセージ");コード削除では、対象のコードそのものをファイルから取り除きます。
コメントアウトが適しているのは、次のような場面です。
動作確認のために一時的に処理を止めたい
デバッグ中に実行結果を比較したい
すぐに元へ戻す可能性がある
一方、今後使用する予定がないコードは、コメントアウトではなく削除するのが基本です。
// 以前使っていた処理// CalculateOldPrice();// UpdateOldDatabase();// SendOldNotification();不要なコードをコメントとして残し続けると、ファイルが読みにくくなり、現在必要な処理との区別がつきにくくなります。
Gitなどのバージョン管理システムを使用していれば、削除したコードも過去の履歴から確認できます。そのため、完全に不要になったコードを「念のため」という理由だけでコメントアウトして残す必要はありません。
一時的に無効化するならコメントアウト、今後使わないなら削除、と使い分けるとコードを整理しやすくなります。
2. C#で1行をコメントアウトする方法
C#で1行をコメントアウトする場合は、//を使用します。
//以降に書かれた内容は、行末まですべてコメントとして扱われます。C#を学び始めたばかりの方は、まずこの書き方を覚えましょう。
2-1. 「//」を使った1行コメントの書き方
1行全体をコメントアウトするには、行の先頭に//を記述します。
// Console.WriteLine("Hello, C#");このコードはコメントとして扱われるため、実行しても文字は表示されません。
コードの説明を書く場合も、同じように//を使用します。
// ユーザー名を表示するConsole.WriteLine(userName);コメントは日本語でも英語でも記述できます。
// ユーザー情報を取得するGetUserData();// Get user dataGetUserData();
チームで開発する場合は、コメントに使用する言語や表記方法を統一すると読みやすくなります。
複数の行をそれぞれコメントアウトしたい場合は、各行の先頭に//を付けます。
// int price = 1000;// int quantity = 3;// int total = price * quantity;// Console.WriteLine(total);上記の4行は、すべて実行されません。
Visual Studioでは、複数行を選択してコメントアウト用のショートカットを実行することで、各行にまとめて//を付けられます。Windows環境の標準的なキーボード設定では、次のショートカットが使われます。
コメントアウト：Ctrl + K、続けて Ctrl + Cコメント解除：Ctrl + K、続けて Ctrl + U最初にCtrl + Kを押し、その後にCtrl + CまたはCtrl + Uを押します。同時にすべてのキーを押す操作ではありません。
環境やキーバインドの設定によっては、ショートカットが異なる場合があります。操作できない場合は、Visual Studioのキーボード設定や、エディター上部のメニューを確認してください。
2-2. コードの行末にコメントを書く方法
//は、行の先頭だけでなく、コードの後ろにも記述できます。
int taxRate = 10; // 消費税率この場合、//より前にあるコードは実行され、//より後ろの内容はコメントとして扱われます。
Console.WriteLine("開始"); // 処理開始を画面に表示する行末コメントは、変数の意味や特別な値の理由などを短く説明するときに便利です。
int retryCount = 3; // 外部サービスの一時的なエラーを考慮して3回まで再試行一方で、長い説明を行末に書くと、コードが横に長くなって読みにくくなります。
int retryCount = 3; // 外部サービスとの通信で一時的なエラーが発生する可能性があるため、失敗した場合は最大で3回まで処理を繰り返す説明が長くなる場合は、コードの直前にコメントを書くほうが読みやすくなります。
// 外部サービスの一時的な通信エラーを考慮し、// 失敗した場合は最大3回まで再試行するint retryCount = 3;また、行末コメントを付けすぎると、重要な情報が埋もれてしまいます。
int price = 1000; // 価格int quantity = 2; // 数量int total = 2000; // 合計変数名だけで意味が十分に伝わる場合、コメントは必須ではありません。コードだけでは分からない理由や注意点がある場合に、行末コメントを使いましょう。
まとめ
C#のコメントアウトは、コードを削除せずに実行対象から外したり、処理の目的や注意点を記録したりするための機能です。
1行をコメントアウトする場合は、//を使用します。
// この行は実行されないConsole.WriteLine("この行は実行される");コードの行末に//を書くと、コードを実行しながら補足コメントを残せます。
int retryCount = 3; // 最大試行回数Visual Studioでは、Windows環境の標準的な設定で、Ctrl + Kに続けてCtrl + Cを押すとコメントアウトでき、Ctrl + Kに続けてCtrl + Uを押すとコメントを解除できます。
コメントアウトはデバッグや一時的な動作確認に便利ですが、不要なコードを長期間残す目的で使うものではありません。一時的に止めるコードはコメントアウトし、今後使わないコードは削除することで、読みやすく管理しやすいC#コードを保てます。