内容別リスト/基本/コメント - 競技プログラミング用 知識集積所

---

雑な説明

プログラムにコメントを書く。
実行時には無視されるメモを残すことができる。

プログラムを書くというよりは、そのための補助に使うもので、難易度問わず利用する。
また、解説コードなどではコード例にコメントが書き足してあることが多い。
他人の解説などを読むときに混乱しないよう、実力問わず正しい知識を身に着けておきたい。

短時間のコンテストではコメントを書いている時間ロスが大きな損。
しかし、後で提出前に見直したいところや、もしWAが出た場合に真っ先に疑いたいところなどは短くメモしておくと助かることも。

長時間（数日以上）のヒューリスティック系コンテストでは、各変数の意味やロジックをなるべくコメントで残しておきたい。
「明日の自分は他人と思え」

基本的な記述

1行のコメント

// スラッシュ2つ書くと、その行のそこより右が全部コメントになる

複数行のコメント

/*
この間に
書いた内容が
全部コメントになる
*/

発展的な記述

コードをまとめて有効化/無効化する

切り替えたいところの前後に以下のように書く。この状態では間のコードは有効。

//*
いろいろ（有効）
//*/

最初のスラッシュを1つ消すと、その間をまとめて無効化できる。

/*
いろいろ（無効）
//*/

もちろんスラッシュを1つ付け足せばまた有効化できる。

2種類のコードを切り替える

切り替えたいところの前後に以下のように書く。この状態ではAの方が有効。

//*
いろいろA（有効）
/*/
いろいろB（無効）
//*/

最初のスラッシュを1つ消すと、Aを無効化してBを有効化できる。

/*
いろいろA（無効）
/*/
いろいろB（有効）
//*/

もちろんスラッシュを1つ付け足せばまたAの方を有効化できる。

範囲にまとめて//をつける

AtCoderコードテストやVSCodeでコードを書いている場合、範囲選択してCtrl+/を押すと、その範囲全体をコメント化したり、逆にその範囲全体のコメントを解除したりできる。
他の環境でも、これが可能なものは多い。

注意点

無効化したのを忘れてそのまま提出しないようにする

有効化/無効化を活用する場合、ちゃんと最後に有効無効の設定が意図通りになっているかを提出前に確認すること。

/*……*/はネストできない

うっかり

/* コメント1の途中に  /*コメント2*/  を挟む */

と書くと、1つ目の「/*」から1つ目の「*/」までがコメント範囲と判定されてしまって、「を挟む */」がコメント扱いされない。
こういう記述をしないように注意すること。