プログラム言語にはソースコードの中にメモ書きを残したり、コードを消さずに一時的に無効化するためにコメントを書く機能が用意されています。Pythonにもコメントアウト機能は用意されていますので、用途と書き方を知っておくと便利です。
目次
コメントアウトとは
ソースコードの中にコメントとして記述された部分はプログラムの実行時に無視されます。
例えば次のコードでは1行目と3行目はプログラムコードとして実行されますが、2行目はコメントアウトされているためプログラムの実行に影響しません。
print("1行目")
# print("2行目")
print("3行目")
実行結果は次のようになります。
1行目
3行目
コメントを残すことで人間がコードを読む際にその内容を理解しやすくなるため、複数人での開発やコードの修正・変更、開発の引継ぎなどがスムーズになります。
1行コメントの書き方
1行だけコメントアウトしたい場合は次のようにシャープと半角スペースに続けてコメントを記述します。半角スペースは必須ではありませんが、コードの可読性を高めるためにも書いておきましょう。
# この行はコメントです。
print("hello world")
行の途中からコメントアウトするには次のように記述します。
print("hello world") # この部分がコメントです
1行コメントは次のように変数の値や、処理の始まりに簡単なメモを残しておきたい場合に有用です。
i = int(input()) # 標準入力から整数を取得
# ここから条件分岐
if i < 5:
print("5未満です")
else:
print("5以上です")
複数行コメントの書き方
複数行のコメントを書くには次のように、該当する行をシングルクォーテーションまたはダブルクォーテーション3つで囲います。
"""
この行はコメントです
この行もコメントです
"""
print("ハローワールド")
この方式は『ドックストリング（docstring）』と呼ばれ、プログラムや関数の解説を書く際に使われます。
"""
この関数は標準入力から整数値を受け取り、それが5未満か5以上かを判定して文章を表示します。
5以外の数を判定したい場合はコード内の数値を編集してください。
"""
def checker():
i = int(input())
if i < 5:
print("5未満です")
else:
print("5以上です")
また、該当部分のコードをコメントアウトすることでコードを消さずに一時的に無効化し、他のコードを試してみるといった使い方もできます。
i = int(input())
"""
if i < 5:
print("5未満です")
else:
print("5以上です")
"""
if i < 100:
print("100未満です")
else:
print("100以上です")
適切なコメントを書くことはソースコードの可読性を高めることに繋がり、プログラムの運用・修正・引継ぎを効率化することに繋がります。プログラムが大規模になるほど適切なコメントを書く重要性は増すので覚えておきましょう。
