Pythonは主に2種類のコメントアウトがあります.
- ハッシュ文字(#)を使ったコメントアウト
- トリプルクォート(”’, “””)を使ったコメントアウト
コメント書ける点は一緒ですが,使い方や処理内容に違いがあります.
今回はPythonのコメントの書き方について紹介します.
ハッシュ文字を使ったコメント
ハッシュ文字# を使うと1行コメントが書けます.
# コメント
ハッシュ文字# のあとに書かれた処理は実行されません.
# print('ベンチプレス')
print('デットリフト')
ベンチプレスの行はハッシュ文字# でコメントアウトしたため出力されていませんね.
コメントアウトは処理内容を説明するときに使います.
チームのルールにも寄りますが日本語で書くことも多いでしょう.
コメントがあると処理の意図が分かりますね!
公式リファレンスにもコメントに関する記述がありました.
時間あるときに目を通しておきましょう.
2. 字句解析
Python で書かれたプログラムは パーザ (parser) に読み込まれます。パーザへの入力は、 字句解析器 (lexical analyzer) によって生成された一連の トークン (token) からなります。この章では、字句解析器がファイルをトークン列に分解する方法について解説します。 Python はプログ...
トリプルクォートを使ったコメント
トリプルクォート”’, “”” を使うと複数行コメントが書けます
シングル,ダブルどちらでも問題ありません.
'''
シングルクォートを使ったコメント
'''
"""
ダブルクォートを使ったコメント
"""
このコメントは主に関数でよく使われます.
def workout():
'''
本日のメニューを出力する
胸と脚を鍛える
'''
print('ベンチプレス')
print('デットリフト')
workout()
シングルとダブル併用で使うことはできないので注意しましょう.
def workout():
'''
本日のメニューを出力する
胸と脚を鍛える
"""
print('ベンチプレス')
print('デットリフト')
workout()
複数行コメントを出力する
複数行のコメントは変数に入れたり出力ができます.
コメントを改行していれば,その改行が残ったまま表示されます.
これはリテラル中の改行が改行文字として反映されるためです.
menu = """
本日のメニューを出力する
胸と脚を鍛える
"""
print(menu)
改行だけでなくインデントもそのまま表示されます.
menu = """
本日のメニューを出力する
胸と脚を鍛える
"""
print(menu)
トリプルクォートを使ったコメントを出力できました.
改行やインデントも一緒に出力できると覚えておきましょう.
まとめ
今回はPythonのコメントアウトについて紹介しました.
コメントアウトは2種類あります.
- ハッシュ文字 # を使ったコメントアウト
- トリプルクォート(”’, “””)を使ったコメントアウト
ハッシュ文字# を使うと1行だけコメントが書けました.
ハッシュ文字# のあとは実行対象から外れるためコメントの出力はできません.
トリプルクォート”’, “”” を使うと複数行に渡ってコメントが書けました.
変数に入れたり,出力ができましたね.
状況に適してコメントを使い分けましょう!