Pythonで複数行をコメントアウトする方法を解説!!

コラム

 Pythonのコードにコメントを書くときに複数行をいっぺんにコメントにしたい!思うことはないでしょうか?

この記事では、複数行のコメントを書くシンプルな方法とエラーになってしまう時の対処法を紹介しています!いっぺんにコメントアウトしてコメントをサクサク書きたい人は必見です!!

1行のコメントの書き方を知りたい場合はこちら↓

1-2 コードの書き方②
Pythonを勉強する前に知っていなくてはならないpythonの記述ルールの基本を知っていますか?この記事では変数名のつけ方、コメントのやり方、改行の扱いについて説明しています。是非ご覧ください!!

複数行のコメントを書く方法

 Pythonで複数行のコメントを書きたい場合、ダブルクォーテーションマーク( ” )を3つ繋げたもので挟むことで実現することができます。

実際にコードにすると以下のようになります。2行まとめてコメントになっていることが分かります。

mport matplotlib.pyplot as plt

"""
果物の価格を比べたいので、Pythonを使って棒グラフにしてみました!!
Pythonでは外部ライブラリを使ってグラフを作ることができちゃうんです!!
"""

price = [100, 900, 380, 500]
x=[1,2,3,4]

labels = ["raspberry","apple","banana","pineapple"]


plt.bar(x, price,tick_label = labels)


plt.xlabel("fruit")
plt.ylabel("price")

plt.show()

このようにダブルクォーテーションマーク3つでコメントにしたい部分を囲うことで、その範囲はコメントとして認識されるようになります。

エラーになってしまう時の対処法

 今回紹介した方法で複数行のコメントを書いてエラーになってしまう場合、以下の理由が考えられます

  1. その部分をコメントにすると、そのほかの部分が文法的におかしくなる
  2. クォーテーションマークが全角になっている
  3. 連続している複数行コメントでインデントしてしまっている

もちろんこれ以外にも理由が考えられるかもしれませんが、ここでは上記3つについての解決策を紹介します

1.コメント以外の部分が原因のパターン

 コメントにした部分はコードとしてみなされないので、コード上には存在しないことになります。すなわち消してはいけない部分をコメントアウトすると、当然エラーになるわけです。

簡単な例を見てみましょう。まずはコメントアウトする前のコードです

#1行目int型の整数xを用意
x=1

#2行目文字列型のyを用意
y="1"

#3行目yをint型に変換
y=int(y)

#4行目xとyの足し算
answer=x+y

#5行目答えを表示
print(answer)

#実行結果:2

このコードは1を代入したxとyの足し算の答えを計算しています。

しかし、int型の変数と文字列型の変数の足し算できないので、3行目で文字列をint型に変換しています。このコードの型を変換している3行目をコメントアウトしてみます。

#1行目int型の整数xを用意
x=1

#2行目文字列型のyを用意
y="1"

"""
3行目yをint型に変換
y=int(y)
"""

#4行目xとyの足し算
answer=x+y

#5行目答えを表示
print(answer)

#実行結果:TypeError

コメントアウトにより3行目の処理が行われなくなったことで、4行目の処理がTypeErorrになってしまいました。

このようにコメントアウトする場合は、その部分をコメントにしていいのかよく考えるようにするといいと思います。

2.クォーテーションマークが全角になっている

 非常に初歩的であるため解説の必要はないかもしれませんが、クォーテーションマークは小さいため見間違いをしやすいです。エラーになったときは一度確認するようにしましょう。

下に正しく入力できるようにコピペ用にコードを這っておきます。

"""
ここにコメントここにコメントここにコメントここにコメントここにコメント
ここにコメントここにコメントここにコメントここにコメントここにコメント
ここにコメントここにコメントここにコメントここにコメントここにコメント
"""

3.インデントによるエラー

 連続で複数行のコメントを書く場合、インデントをそろえないとエラーになってしまいます。(インデントとはキーボードで「Tab」を押したときに入力される字下げのこと)

エラーになってしまう例を下に挙げます。

a=100
b=200
print(a*b*10)
"""
コメント
コメント
"""
    """
    コメント
   コメント
    """
#実行結果:IndentationError

 このように複数行のコメントを書くときにはインデントにも注意が必要です。

まとめ

 今回の記事では複数行のコメントの書き方を紹介しました。よくありそうなエラーについても簡単に対処法を載せたのでお役に立てれば幸いです!

スポンサーリンク
コラム
図で分かるPython入門講座

コメント

タイトルとURLをコピーしました