Pythonでのコメントの書き方について学んでいきましょう。
コメントの書き方
Pythonでコメントを書くためには、#を使います。
この#は、コードの途中に書いても良いです。
具体的なコードを見ていきましょう。
コード#これはコメントとされます。
a = 1
b = 2 #これもコメントとして機能します。
Pythonは#以下の文章を無視しますので実際にコードが実行される時に#の先の文章は無いものとされます。
コード内にコメントを書く時の推奨ルール
コードの中にコメントを書くときには、1つだけルールがあります。
それは、コードとコメントの間は2文字分以上のスペースを空ける、というものです。
スペースが無くてもコードは実行されるのですが、コードとコメントが近いとどれがコードでどれがコメントか分かりにくくなってしまいます。
ですので、コード中にコメントを書く場合は2文字以上のスペースを空けるということがPEP8で定められています。
なお、PEP8に従った書き方は、あくまでも「推奨」ルールです。強制されるものではありまえせん。
コメントが複数行になる時
コメントが複数行になる時は、引用符（シングルクオテーションかダブルクオテーション）を3回続けることでコメントとすることができます。
コード''' This is a pen.
That is a pencil.
There are pens.'''
なお、引用符を3つ続けた書き方は、文字列のデータを定義する時にも使われますので注意しましょう。
実際のコードをご紹介します。
コードpen = ''' This is a pen.
That is a pencil.
There are pens.'''
print(pen)
アウトプットThis is a pen.
That is a pencil.
There are pens.
三重引用符を使う場面
ここでは、三重引用符を使う場面についてお伝えします。
関数の説明を書く場合
まずは、関数を使う場面です。関数は後ほど出てくる概念ですので、ここではあくまでも三重引用符の使い方に限って説明します。
三重引用符は、関数の中身を説明する時に使います。
具体的なコードで見てみましょう。
コードdef plus(a + b):
'''この関数は、aとbを足すために使われます'''
return a + b
この関数はパッと見るだけで何をする関数なのかイメージがつきやすいですが、何には非常に複雑な処理をする関数もあります。
そういった場合に、関数の説明が書かれていると親切ですね。
良いコメントとは
最後に、良いコメントとはどのようなコメントなのかお伝えしていきます。
良いコメントとは、一言で言うと「分かりやすい」コメントです。
そして、良いコメントが何かを理解するためには、悪いコメントを見た方がイメージが湧きやすいですので、実際に悪いコメントの例を見てみましょう。
コードreturn a # 変数aを返します
変数aを返します。というのはコードが書いてあることそのままで、説明になっていません。
ここでは、aが何かを説明すると分かりやすいコメントになります。
（そもそも、aという変数名を定義することが間違いなのですが。。）
コード# 変数bが代入される先を修正
コメントだけ書きましたが、これでもイメージが湧くのではないかとおもいます。
このコメントは、一言でいうと「指示があいまい」なコメントです。
「b代入される先」とありますが、bが何なのか分からず、さらにbがどこに修正されるのかも分かりません。
とくに、自分でコードを書いている時は「目的語」を省略してしまいがちです。
誰が読んでも同じ解釈になるようなコメントを書くことを心がけましょう。