コメントの書き方

このレッスンでは、Pythonにおけるコメントの書き方を学び、あとから読み返しても分かりやすいコードを書けるようになることを目標にします。「Python コメントアウト 書き方」で検索している初心者の方向けです。

コメントは、プログラムの動作には影響しない「人間向けのメモ書き」です。#を付けた部分がコメントになります。複数行にはダブルクォート3つで囲む書き方もよく使われます。あとで自分や他の人がコードを読んだときに分かりやすくするために書きます。

サンプルコードでは、1行コメントで変数の説明を加え、複数行コメント(トリプルクォート)でまとまった説明を書いています。「なぜこの処理が必要なのか」という背景を書き残しておくと、数か月後の自分やチームメンバーがコードを見返したときに大いに役立ちます。

初心者がよくつまずくのが、コメントを書きすぎてしまい、かえってコードが読みにくくなるケースです。「何をしているか」はコード自体を読めば分かることが多いため、コメントには「なぜこの処理が必要なのか」という背景を書くのが効果的です。関数の説明として書く"""コメントは「docstring」とも呼ばれます。

実際の開発現場では、チームで開発するときにコメントの有無が大きな差を生みます。docstringはドキュメント生成ツールで自動的に読み取られることもあり、コメントの書き方そのものが実務のコーディングスキルの一部として評価される要素です。