【Python】コメントの方法とコメントアウトについて

comment out eyecatch image

pythonでのコメントの方法とコメントアウトについてです。コメントとは、コード入力画面で命令プログラムとは認識されない(コード実行時に無視される)が、コード入力画面には記載されている文字列の事を指します。また、コメントアウトとはコードとして書かれた部分をプログラムとして認識されないようにコメント化する事をいいます。

目次

コメントの記入方法

よくコメントは各コードの説明に使われます。個人的な経験でいうと、自分で書いたコードであっても1,2週間も経つとどういう意図があって書いたコードかわからなくなります。ましてや他人が書いたコードであれば、なおさらです。そういった事を避け、可読性を向上させる意味でコメントを残すことは大事です。

また、コメントの記入方法としては次の2つの方法が主です。
1.シャープ(#)を用いたコメント
2.3つの連続したダブルクォーテーション(”””)またはシングルクォーテーション(’’’)で挟む

#(シャープ)を用いたコメントの記入方法

コメントの記入方法ですが、コメントとして残したい文字の文頭に #(シャープ)をつけます。

Python
#print("コメントの記入例です")
print("文頭に#がつくとコメントと認識され、表示れません")

'''
【出力結果】
文頭に#がつくとコメントと認識され、表示されません

上記の通り、最初のprint()関数はコメントとなっており、プログラムとして認識されていないので、出力されていません。また、上記”’【出力結果】文頭に#がつくと~~~の部分も”’以降がコメントとして認識されているので文字がオレンジ色になっています

三重クォートを用いたコメント

先程の#を用いたコメント以外にも3つの連続したダブルクォーテーション(“””)またはシングルクォーテーション(”’)で挟むことによって、コメントにできます。大きな違いとして#では1つの行でしか、コメントにできませんが、三重クォートでは、クォーテーションで挟まれた複数行を一気にコメントにすることができます。これは後述するコメントアウトの時に重宝します。

Python
"""print("ダブルクォーテーションで挟まれた
部分はコメントになって、出力されません。")"""

'''print("シングルクォーテーションでも同様で
三行にまたがったとしても、
コメントなので、出力されません")'''
print("この部分のみプログラムとして認識されています。")

'''
【出力結果】
この部分のみプログラムとして認識されています。

コメント記入時の注意点

コメントを書くのは大事なことですが、コード一文に対して、1つのコメントを残すことはあまり推奨されません。コメントが多くなりすぎて、逆に読みにくくなるからです。以下がその例です。

悪いコメントの例

Python
#aに1を代入
a = 1
#bに2を代入
b = 2
#aにaとbをかける
a * b

良いコメントの例

Python
#aとbに値を代入し、aとbを掛け算
a = 1
b = 2
a * b

上記コードのabの事を変数といいます。代入や変数については、こちらの記事をご参照ください。

コメントアウトとは

コメントアウトとは冒頭でも紹介しました通り、コードとして書かれた部分をプログラムとして認識されないようにコメント化する事です。

そもそもの考え方なのですが、新しいコードを書いたら、それが正常に動作するかという確認を行うのが基本です。(特に私のような初心者の場合、たくさんのコードを書いて実行して、エラーがでたら、どこに問題があるか見つけるのが大変だからです)

その為、1つ新しいコードを書く→実行→新しいコード作成→実行…を繰り返しますが、この時に前に書いたコードが邪魔になる時があります。そういった時にコメントアウトを使ってコメント化すると効率良くプログラミングが可能になります。

コメントアウトの方法

コメントアウトの方法ですが、コメント化するのが目的なので、これまで記載した通りの
文頭に#をつける
もしくは
三重クォート(”””もしくは’’’)で挟む
となります。

コードを書いていてちょっとこのコード邪魔だなという時に使っています。

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメントする

CAPTCHA


目次