C++のコメントアウト方法には、主に「1行コメント」と「ブロックコメント」の2種類があります。
1行コメントは、ある位置からその行の終わりまでをコメントとして扱う方法です。
短い説明や、コードの一部を一時的に無効化したいときによく使われます。
ブロックコメントは、指定した開始位置から終了位置までの範囲をコメントとして扱う方法です。
複数行にわたる説明を書きたい場合や、まとまった範囲をコメント化したい場合に使われます。
どちらの方法も、コメントとして書かれた部分はプログラムの実行対象にはなりません。
1行コメントとは
1行コメントの基本
1行コメントは、C++で最もよく使われるコメント方法です。
コメントを書き始めた位置から、その行の終わりまでがコメントとして扱われます。
短い説明を書いたり、処理の意味を補足したりするときに便利です。
たとえば、変数の意味、処理の目的、注意点などを簡単に残したい場合に向いています。
行の途中からでも使える
1行コメントは、行の先頭だけでなく、コードの後ろにも書くことができます。
この書き方は、変数や処理に対して短い補足を入れたいときによく使われます。
ただし、説明が長くなりすぎると読みづらくなるため、長い説明はコードの前に別行で書く方が自然です。
一時的にコードを無効化するときにも使える
1行コメントは、デバッグ中にコードを一時的に実行させないようにする目的でも使われます。
たとえば、確認用の出力処理を一時的に止めたい場合や、一部の処理を外して動作確認したい場合に便利です。
複数行をまとめてコメントアウトしたい場合でも、エディタやIDEのショートカットを使えば、複数行に対して一括で1行コメントを付けられます。
ブロックコメントとは
ブロックコメントの基本
ブロックコメントは、指定した範囲全体をコメントとして扱う方法です。
一般的には「複数行コメント」と呼ばれることもありますが、必ずしも複数行で使う必要はありません。
1行の中だけでも使えます。
より正確には、「ブロックコメント」または「範囲コメント」と考えるとわかりやすいです。
複数行の説明に向いている
ブロックコメントは、複数行にわたる説明を書きたい場合に向いています。
たとえば、関数全体の目的、複雑な処理の背景、注意事項、仕様上の理由などをまとめて書くときに便利です。
短い補足には1行コメント、まとまった説明にはブロックコメント、という使い分けをすると読みやすくなります。
コードの一部をまとめて無効化することもできる
ブロックコメントは、複数行のコードをまとめて無効化する目的でも使えます。
ただし、この使い方には注意が必要です。コメントアウトしたい範囲の中に、すでにブロックコメントが含まれている場合、意図しない位置でコメントが終了してしまうことがあります。
そのため、複数行のコードを一時的に無効化する場合は、ブロックコメントよりも、各行に1行コメントを付ける方が安全なことがあります。
1行コメントとブロックコメントの違い
使える範囲が違う
1行コメントは、その行の終わりまでがコメントになります。
一方、ブロックコメントは、開始位置から終了位置までの範囲がコメントになります。
その範囲が1行だけでも、複数行にまたがっていても問題ありません。
向いている用途が違う
1行コメントは、短い説明や簡単な補足に向いています。
ブロックコメントは、長めの説明や複数行にわたるメモに向いています。
実務では、普段のコメントには1行コメントを使うことが多く、まとまった説明を書きたいときにブロックコメントを使うことが多いです。
コメントアウトするときの注意点
ブロックコメントは入れ子にできない
C++では、ブロックコメントの中にさらにブロックコメントを入れることはできません。
これを知らずに複数行のコードをまとめてコメントアウトすると、途中でコメントが終わってしまい、コンパイルエラーの原因になることがあります。
特に、すでにコメントが含まれているコード全体を一時的に無効化したい場合は注意が必要です。
文字列の中にある記号はコメントにならない
コメントを表す記号が文字列の中に書かれている場合、それはコメントとして扱われません。
たとえば、URLの中に含まれるスラッシュや、文字列として書かれたコメント記号は、あくまで文字列の一部です。
この点は、初心者が混乱しやすい部分です。
コメントとして扱われるのは、文字列の外に書かれたコメント記号だけです。
コメントは厳密には空白のように扱われる
初心者向けには「コメントはコンパイラに無視される」と説明されることが多いです。
これは実用上は正しい理解です。
ただし、C++の仕様に近い言い方をすると、コメントは翻訳の早い段階で空白のように扱われます。
通常の学習や実務では、「コメント部分は実行されない」「プログラムの動作に直接影響しない」と理解しておけば十分です。
コメントとコメントアウトの違い
コメントとは
コメントとは、コードの意味や意図を説明するために書くメモのことです。
処理の目的、注意点、仕様の背景などを残しておくことで、後から読んだ人が理解しやすくなります。
自分で書いたコードでも、時間が経つと意図を忘れることがあります。
そのため、適切なコメントは保守性を高めるうえで役立ちます。
コメントアウトとは
コメントアウトとは、本来は実行されるコードをコメントにして、一時的に無効化することです。
たとえば、デバッグ用の処理を一時的に止めたい場合や、ある処理を外して動作確認したい場合に使います。
つまり、厳密には「コメント」と「コメントアウト」は少し意味が違います。
コメントは説明を書くこと、コメントアウトはコードを無効化することです。
ただし、日本語のプログラミング学習では、コメントを書くこと全般を「コメントアウト」と呼ぶこともあります。
実務でも意味は通じることが多いです。
良いコメントの書き方
コードをそのまま説明するだけのコメントは避ける
良いコメントは、コードを単に日本語に言い換えるだけではありません。
コードを見ればわかることをそのまま書いても、あまり役に立たないことがあります。
たとえば、「値を足す」「変数に代入する」といった説明は、コードを読めばわかる場合が多いです。
なぜその処理をしているのかを書く
役に立つコメントは、「何をしているか」よりも「なぜそうしているか」を説明していることが多いです。
処理の背景、仕様上の理由、例外対応の理由、注意すべき条件などを書くと、後から読んだ人にとって有益です。
特に、少し不自然に見える処理や、将来変更すると問題が起きそうな処理には、理由を書いておくと安全です。
コメントよりもわかりやすい名前を優先する
コメントを増やす前に、変数名や関数名をわかりやすくすることも大切です。
名前だけで意味が伝わるコードは、コメントが少なくても読みやすくなります。
逆に、名前がわかりにくいままコメントで補足しようとすると、コード全体が読みにくくなることがあります。
理想は、コード自体ができるだけ読みやすく、必要な部分だけコメントで補足されている状態です。
IDEやエディタのコメントアウト機能
ショートカットで一括コメントアウトできる
多くのIDEやエディタでは、選択した行をショートカットでまとめてコメントアウトできます。
Visual Studio Code、Visual Studio、CLionなどでは、複数行を選択して一括でコメント化したり、コメントを解除したりできます。
これを使うと、デバッグ時に複数行を一時的に無効化しやすくなります。
ショートカットは環境によって異なる
コメントアウトのショートカットキーは、使用しているエディタ、OS、キーボード配列、設定によって変わることがあります。
特に、日本語キーボードと英語キーボードでは操作感が異なる場合があります。
そのため、具体的なショートカットは、使っている開発環境の設定やヘルプで確認するのが確実です。
前回の内容に間違いはあったか
大きな間違いはない
前回の説明は、C++のコメントアウト方法として大きな間違いはありません。
1行コメントとブロックコメントの使い方、コメントが実行されないこと、ブロックコメントが入れ子にできないこと、文字列の中ではコメント記号として扱われないことなど、基本的な説明は正しいです。
より正確にするなら補足が必要
より厳密に説明するなら、いくつか補足した方がよい点があります。
まず、ブロックコメントは「複数行コメント」と呼ばれることもありますが、1行でも使えるため、「ブロックコメント」と呼ぶ方がより正確です。
また、コメントは単純に消えるというより、C++の翻訳過程で空白のように扱われます。
ただし、初心者向けには「実行されない」「無視される」という理解で問題ありません。
さらに、IDEのショートカットキーは環境によって異なるため、あくまで代表例として紹介するのが適切です。
まとめ
C++のコメントアウトは2種類を覚えればよい
C++のコメントアウトでは、基本的に1行コメントとブロックコメントの2種類を覚えておけば十分です。
普段の短い説明には1行コメントを使い、複数行にわたる説明やまとまった範囲のコメントにはブロックコメントを使います。
複数行のコードを無効化するときは注意する
複数行のコードを一時的に無効化する場合、ブロックコメントを使うと便利ですが、すでにブロックコメントが含まれている範囲では問題が起きる可能性があります。
そのため、実務ではエディタの一括コメント機能を使って、各行に1行コメントを付ける方法が安全な場面も多いです。
良いコメントは理由を伝える
コメントは、コードをただ説明するためだけのものではありません。
なぜその処理が必要なのか、どのような意図があるのか、どんな注意点があるのかを伝えることで、コードの読みやすさと保守性が高まります。
C++のコメントアウト方法自体は難しくありませんが、読みやすいコメントを書くには、使い方だけでなく、書く内容にも気を配ることが大切です。
以上、C++のコメントアウトの方法についてでした。
最後までお読みいただき、ありがとうございました。
