Pythonのコメントアウト
はじめに
プログラムを書くとき、コードの一部を一時的に無効にしたり、コードの意味を説明したりしたいことがあります。
そんなときに使うのが コメントアウト です。
コメントアウトは、Pythonに「ここは実行しなくてよい部分です」と伝える役割があります。
コメントアウトの書き方
1. 一行コメント
行の先頭に # をつけると、その行は実行されません。
# これはコメントです
print("こんにちは") # ここもコメントです
- 上の例では、
# これはコメントですはプログラムとしては無視されます print("こんにちは")の後のコメントも同様に無視されます
2. 複数行コメント(実質)
Pythonには厳密な複数行コメントはありませんが、三重引用符(""" または ''') を使うことで複数行の説明を入れることができます。
"""
これは複数行のコメントのように使える部分です。
プログラムには影響しません。
"""
print("Pythonでコメントを使う例")
- この方法は、ドキュメンテーション文字列(docstring)として使われることもあります
- 普通のコメントとしても、複数行にわたる説明を書きたいときに便利です
コメントアウトの活用例
- コードの意味を説明する
# 変数に年齢を入れる
age = 20
- 一時的に処理を止める
# print("この行は一時的に実行したくない")
print("この行だけ実行されます")
- メモとして残す
# TODO: 後でここに関数を作る
コメントを書くことで、自分や他の人がコードを理解しやすくなる効果もあります。
まとめ
- コメントアウトはコードの実行に影響を与えない説明文
- 一行コメントは
#を使う - 複数行のコメント風には三重引用符
"""または'''を使う - コメントは、コードの意味を説明する、メモを残す、実験的にコードを止める などに役立つ
コメントをうまく使うことで、後から見てもわかりやすいプログラムになります。
