Pythonのコメントアウトの書き方
Pythonでのコメントアウトは、コードに対して説明や注釈を追加するための手段です。
コメントはコードの実行に影響を与えず、開発者がコードの意図や機能を理解しやすくするために利用されます。
Pythonでは主に2つの方法でコメントアウトを行います。
それが「シングルラインコメント」と「マルチラインコメント」です。
シングルラインコメント
シングルラインコメントは、1行だけのコメントを追加する際に使用します。
シングルラインコメントは、#（ハッシュ記号）を行の先頭に置くことで開始します。
# の後に続くすべてのテキストはコメントとして扱われ、実行されることはありません。
例えば：
# これはシングルラインコメントです print("Hello, World!") # この行の後ろもコメントとして扱われます
シングルラインコメントは、行内の任意の場所に挿入できますが、通常は行の先頭に書くのが一般的です。
これにより、コメントがコードの意図を明確にし、コードの可読性を向上させます。
マルチラインコメント
マルチラインコメントは、複数行にわたるコメントを追加したい場合に使用します。
Pythonでは、実際には「マルチラインコメント」という特定の構文は存在しませんが、複数行の文字列リテラル（トリプルクォーテーション）をコメントとして使用することで、同様の効果を得ることができます。
トリプルクォーテーションは、シングルクォーテーション3つ（'''）またはダブルクォーテーション3つ（"""）で囲まれた文字列です。
例えば：
""" これはマルチラインコメントの例です。 複数行にわたる説明や注釈を追加できます。 Pythonではこの形式がコメントとして扱われます。 """ print("Hello, World!")
上記のようにトリプルクォーテーションを使用した文字列リテラルは、コメントアウトの目的で使用されることがありますが、注意が必要です。
というのも、Pythonのインタプリタはこれを実際には文字列リテラルとして認識しますが、実行されないため、事実上コメントとして機能します。
しかし、これがコードのドキュメントストリング（docstring）としても解釈される可能性があるため、ドキュメントストリングと区別がつかない場合があります。
コメントのベストプラクティス
1. 簡潔に記述する:
コメントは簡潔であり、コードの動作を明確に説明するべきです。
冗長なコメントは逆に読みづらくなります。
2. 適切な位置に配置する:
コメントはコードの意図や動作を説明するために配置します。
コードのすぐ上や隣に配置することで、コメントがどのコードに対応しているのかが明確になります。
3. 更新を怠らない:
コードを変更した際には、対応するコメントも更新するように心がけましょう。
古いコメントは混乱を招く原因となります。
4. 目的を明確にする:
コメントは「なぜ」そのコードが必要なのか、または「何をしているのか」を説明するものであるべきです。
コード自体が自明である場合、コメントは必ずしも必要ありません。
コメントはコードの可読性を向上させる重要な要素であり、適切に使用することでコードのメンテナンス性を高めることができます。
