プログラムの説明を書きたいけど長くなるから複数行にわけたい…
でも、1行1行コメントアウトするのは面倒くさい…
プログラミング言語のPythonで、コメントアウトを簡単に行う方法を説明します。
１行だけコメントアウトするとき
「#」(シャープ)の記号を使います。
キーボードで「Shift」を押しながら「3」を押すことで、#記号を入力することができます。
「#」を使うと、#から先はコメントとして認識されます。
プログラムが実行されても、#から先は実行されません。
# シャープ記号で1行だけコメントアウトできます
print('Hello World!')
上記のようなプログラムを書くと、１行目は実行されずに、２行目だけ実行されます。
#の記号は行の途中にも書くことができます。
行の途中に書いた場合は、#の右側のコメントが実行されなくなります。
print('Hello World!') # シャープの右側のみ実行されない
上記のプログラムの場合、printは実行されますが、#の右側のコメントは実行されません。
簡単な説明文を書くときに使えます。
複数行をまとめてコメントアウトするとき
三重引用符「”””」をつけることで、複数行をまとめてコメントアウトすることができます。
「Shift」キーを押しながら「2」を押すことで、引用符「”」を入力することができます。
三重引用符「”””」は、引用符を3回入力してください。
print('Hello World!')
"""
a = 2
print(a)
"""
上記の例の場合、1行目の「Hello World!」は実行されますが、三重引用符で囲まれた部分は実行されません。
ちなみに、Jupiter notebookでは、コメントアウトしたい行をまとめて選択して、
「Ctrl」 + 「/」
キーを一緒に押すことで、コメントアウトすることができます。
コメントアウトの使いどき
コメントアウトは以下の２つの場面で使うと、わかりやすいプログラムを書けます。
- プログラムの内容を説明するとき
- テストで、一時的にプログラムの一部を飛ばしたいとき
それぞれについて解説していきます。
プログラムの内容を説明するとき
プログラムが長くなってくると、そのプログラムの目的が分からなくなってしまいます。
そんなときにコメントアウトを使うと、プログラムの内容が一目で読み取れるようになります。
# 1から10までの合計を求めるプログラム
total = 0
for num in range(1, 11):
total += num
print(total)
たとえば、上記は１から１０までの合計５５を表示するプログラムですが、慣れないうちは内容がすぐに分かりません。
このようなときにコメントが入っていると、後から確認しやすくなります。
テストで、一時的にプログラムの一部を飛ばしたいとき
たとえば、先ほどの１から１０までの合計を求めるプログラム
# 1から10までの合計を求めるプログラム
total = 0
for num in range(1, 11):
total += num
print(total)
において、forの中身をとばして、最初のtotalを表示させたいとします。
このとき、３行目と４行目を削除してしまうと、後でもう一度書き直さなければなりません。
一部の処理をとばすときにも、コメントアウトが使えます。
# 1から10までの合計を求めるプログラム
total = 0
"""
for num in range(1, 11):
total += num
"""
print(total)
上記は複数行のコメントアウトを使って、forの中身が実行されないようにしています。
コメントアウトであれば、テストが終わった後に元に戻すのが簡単にできるようになります。
まとめ
本記事では、Pythonでコメントアウトする方法を解説しました。
1行だけをコメントアウトするときは「#」記号をつけます。
複数行をまとめてコメントアウトするときは「”””」記号をつけます。
コメントを使いこなして、わかりやすいプログラミングコードを書いていきましょう！
