【Python】コメントの書き方は?ハッシュ文字とトリプルクォートの違いを紹介

Python_コメント_書き方 プログラミング言語

Pythonは主に2種類のコメントアウトがあります.

  • ハッシュ文字(#)を使ったコメントアウト
  • トリプルクォート(”’, “””)を使ったコメントアウト

コメント書ける点は一緒ですが,使い方や処理内容に違いがあります.

今回はPythonのコメントの書き方について紹介します.

ハッシュ文字を使ったコメント

ハッシュ文字# を使うと1行コメントが書けます.

# コメント

ハッシュ文字# のあとに書かれた処理は実行されません.

# print('ベンチプレス')
print('デットリフト')
コメントアウトした行は実行されない|クリックして拡大できます

ベンチプレスの行はハッシュ文字# でコメントアウトしたため出力されていませんね.

コメントアウトは処理内容を説明するときに使います.
チームのルールにも寄りますが日本語で書くことも多いでしょう.

コメントアウトがあることで一目でどんな処理内容か分かる|クリックして拡大できます

コメントがあると処理の意図が分かりますね!

公式リファレンスにもコメントに関する記述がありました.
時間あるときに目を通しておきましょう.

2. 字句解析
A Python program is read by a parser. Input to the parser is a stream of tokens, generated by the lexical analyzer(also known as the tokenizer). This chapter de...

トリプルクォートを使ったコメント

トリプルクォート”’, “”” を使うと複数行コメントが書けます
シングル,ダブルどちらでも問題ありません.

'''
シングルクォートを使ったコメント
'''
"""
ダブルクォートを使ったコメント
"""

このコメントは主に関数でよく使われます.

def workout():
    '''
    本日のメニューを出力する
    胸と脚を鍛える
    '''
    print('ベンチプレス')
    print('デットリフト')
    
workout()
複数行コメントする|クリックして拡大できます

シングルとダブル併用で使うことはできないので注意しましょう.

def workout():
    '''
    本日のメニューを出力する
    胸と脚を鍛える
    """

    print('ベンチプレス')
    print('デットリフト')
    
workout()
シングルクォートとダブルクォートは併用するとエラーになる|クリックして拡大できます

複数行コメントを出力する

複数行のコメントは変数に入れたり出力ができます.

コメントを改行していれば,その改行が残ったまま表示されます.
これはリテラル中の改行が改行文字として反映されるためです.

menu = """
本日のメニューを出力する
胸と脚を鍛える
"""

print(menu)
改行された状態で表示される|クリックして拡大できます

改行だけでなくインデントもそのまま表示されます.

menu = """
    本日のメニューを出力する
    胸と脚を鍛える
"""

print(menu)
インデントされた状態で表示される|クリックして拡大できます

トリプルクォートを使ったコメントを出力できました.
改行やインデントも一緒に出力できると覚えておきましょう.

まとめ

今回はPythonのコメントアウトについて紹介しました.

コメントアウトは2種類あります.

  1. ハッシュ文字 # を使ったコメントアウト
  2. トリプルクォート(”’, “””)を使ったコメントアウト

ハッシュ文字# を使うと1行だけコメントが書けました.
ハッシュ文字# のあとは実行対象から外れるためコメントの出力はできません.

トリプルクォート”’, “”” を使うと複数行に渡ってコメントが書けました.
変数に入れたり,出力ができましたね.

状況に適してコメントを使い分けましょう!