Pythonのコメントアウトの書き方(複数行・範囲)

  • 2020.02.13
  • (更新日:2020.02.19)
  • python
Pythonのコメントアウトの書き方(複数行・範囲)

Pythonに限らず、全てのプログラムでコメントは、自分自身もそうですが、他のチームの方等がソースを見たときの理解に役立ちます。
プログラムで大切な事の一つとして「わかりやすく書くこと」がよく言われます。
「どのような動作をするコードなのか」や「何の処理をするコードなのか」を端的に表すコメントを書くことで、他の方に伝わりやすくメンテナンスしやすいプログラムとなります。

コメントの使われ方

コメントの使われ方は大きく2種類あります。
1つ目は先ほどお話ししたプログラムの中身がわかるようするため補足的なコメントを書くことです。
コードの中身を上手に伝えるコメントを記述すれば、読み手の理解に繋がり保守がしやすくなります。

2つ目はプログラムのデバッグ時に、原因を特定するために一時的に動作を止めたいコードをコメントにすることです。

コメント(コメントアウト)の書き方

それでは、2つのコメントの書き方(行単位・複数行)を解説します。

行単位のコメント

Pythonではコメントは#(ハッシュ記号)で記述すると行末までがコメントとなり、プログラムとして実行されません。
コメントは行の先頭から始める事も出来ますし、ホワイトスペースやコードの後ろにつけることも出来ます。

行の先頭とホワイトスペース

#  一番好きなうまい棒の表示
print(‘明太子味のうまい棒が一番好き’)
	#  ホワイトスペースの後でも大丈夫です。

コードの後ろ

print(‘チーズ味のうまい棒はカールみたいな味’)  #  チーズ味のうまい棒とかーるの比較を表示

当たり前ですが、文字リテラル内部につけてもコメントにはなりません。

文字リテラル内部には付けられない。

print(‘#をつけてもただの文字として処理されます’)

複数行のコメント

他のプログラムには当たり前のようにある複数行のコメント記号が、Pythonにはありません。
ただし、代替になる記述方法はあります。

”’(シングルクォーテーションを3つ)あるいは ”””(ダブルクォーテーションを3つ)を3つでコメントアウトしたい部分を囲んでしまえば、
コメントアウトできます。

複数行

 '''
今日の晩御飯は
うまい棒とビックカツ
 '''

注意点

コメントとして用意されている#であれば行の先頭からでも途中でも良いのですが、
インデントが発生するForやifでは、インデント内で行頭から記述するとエラーになります。

エラーとなるコード

for i in range(5):
    print(i)
 '''
0〜4まで
表示されます。
 '''

正しいコード

for i in range(5):
    print(i)
     '''
    0〜4まで
    表示されます。
     '''

pythonカテゴリの最新記事