Python｜コメントについて学ぼう

コメントとは？

コメントとは、Pythonのプログラムコード上にコードを説明するための記述をすることができます

実際のプログラムを使った開発現場では、開発者自身以外にも他の人が開発に加わる場合があります

そういったときに適切なコメントを残しておくとよりプログラムコードを読みやすくしたり、注意事項を記載しておくことで他の開発者が悩む時間を短縮することができるようになります

コメントを作成する

コメントは“#”をつけることでそれ以降の文字はプログラムコードとして無視されるようになります

# Comment
print("It's raining today")

行の先頭で“#”を付与するとその行すべてがコメントの扱いになります

ここでは緑色部分がコメントになります

実際に実行した場合、プログラムコードとしては無視されます

print("It's raining today") # Comment

行の途中で”#”を付与した場合は付与した後ろの部分がコメント扱いになります

実際のプログラミングコード上でも#以降がコメント扱いとなります

実行した場合はひとつ前と同様にプログラムコードとしては無視されます

#print("It's raining today")
print("Sunny today") 

開発途中でプログラムコード自体を一時的にコメント扱いにして実行することで手軽にプログラムコードの変更後や、コメントで除外する前の状態を試すことができます

緑色の部分はコメント扱いとなるため、実際に実行してみても表示されていません

複数行のコメントを作成する

プログラミング言語によっては複数行まとめてコメントにする方法もありますが、Pythonの場合はそういった構文はありません

そのため複数行コメントを作成する場合は各行に“#”を追加しましょう

# Comment 1
# Comment 2
# Comment 3
print("Cloudy today")

このように緑色の部分すべてをコメントとして扱うことができますが量が多くなると少し面倒ですね

そんなときは、もともとコメントとして用意されたものではないですが、結果として複数行コメントとして使用できる方法があります

"""
Comment 1
Comment 2
Comment 3
"""
print("Typhoon today") 

他のコメントのように緑色にはなりませんが、実行結果からプログラムコード上では無視されています

Pythonでは変数に割り当てられていない文字列リテラルはプログラムコードとして認識されないため、コードの中に複数行の文字列を追加することで複数行コメントとして扱うことができます

この方法は少し特殊な方法のためもし使用するときは、使用するコードの規約に合わせるようにしましょう

記事が参考になったり、気に入ってもらえたら
ポチッとしてもらえると励みになります！