コメントを使う

コメントは、他の開発者や 未来の自分に向けて、 コードが何をするものかを 説明するためのメモです。 今扱っているのは、小さなプログラムです。 けれども、スキルを高めていくうちに、 もっと長いプログラムを 書くようになるでしょう。 中には、数千行のコードが 何十個のファイルに またがっていることもあるでしょう。 そのすべてを覚えておくことは 不可能です。 そこで、コードに コメントを付けることで、 変数や関数、クラスなどの用途を 明確にします。 これらは、仮想的な 付箋紙のようなものです。 では実際に、プログラムで 確認してみましょう。 「03_06_begin.py」を 開いてください。 これは、ユーザーに名前を尋ねたり、 コースを楽しんでいるかどうかを 尋ねるプログラムです。 実行すると、 このように、名前と コースを楽しんでいるかどうかを 尋ねられます。 このプログラムに コメントを追加してみましょう。 まず、１行目に追加してみます。 Python のコメントは、 ハッシュマークで始まります。 ですから、ハッシュマークとスペース、 そして「ユーザに挨拶する」 と入力します。 行全体が緑色になっていることに 注目してください。 これは、VS Code が、 この行がコメントであることを 知らせてくれているのです。 さて、コードにコメントを入れる方法が もうひとつあります。 既存のコードと同じ行に、 コメントを追加することもできるので、 やってみましょう。 ４行目の input 関数の直後に、 スペースとハッシュマークを追加し、 「ユーザに名前を尋ねる」 と入力してみましょう。 これで、コメントを 追加することができました。 Python は、 このハッシュマークを見ると、 行の残りの部分をコメントだと認識します。 これを保存して実行して 出力に何か影響があるかどうかを 見てみましょう。 先ほどと同じように、 挨拶が表示され、 名前を聞かれますね。 Enter キーを押すと、 コースを楽しんでいるかどうかを 尋ねられます。 「はい」と入力すると、 先ほどと同じ結果が得られます。 コメントは、コードの出力に 影響を与えません。 さらにコメントは、 私たちに注意を促すだけではなく、 あるコードを一時的に無効にするために 使用することもできます。 プログラマーは、 よくこのテクニックを使います。 これは、コメントアウトと呼ばれています。 試してみましょう。 例えば、コースについてどう感じるか、 ユーザにもう尋ねる必要が なくなったとしましょう。 それらの行を単に削除するのではなく、 コメントアウトすることができます。 ７行目まで移動して、 行の先頭にハッシュマークと スペースを入れましょう。 ９行目から、12 行目まで 同じようにします。 １行ずつ処理しても構いませんが、 これらの行を選択して、 「編集」メニューの 「行コメントの切り替え」で、 一度にコメントアウトすることもできます。 では、ファイルを保存して、 出力を確認してみましょう。 挨拶が表示され、 名前を聞かれます。 名前を入力して、Enter を押すと、 それで終わります。 コースについて、 どう思うかを聞かれることはありません。 このようにコメントは、 プログラマーにとって 強力なツールとなります。 備忘録として使ったり、 他の開発者に説明したり、 さらには、コードのデバッグに 役立てたりすることができます。