Pythonのコメントの書き方

Pythonのコメント

コメントとはプログラムの動作自体には何も影響しない記述のことを言います。

コメントには多くの場合はプログラムの説明などや備忘などを書きます。どういう処理かということだけでなく何をやりたいのか、ということを書いたりもします。

Pythonでは２通りのコメントの書き方があります。

ハッシュ記号「#」から右の行末までをコメントとします。「#」から左の部分はコメントとはみなされません。

コメントは行の先頭から初めても構いませんし、また、プログラムコードの後ろ（右）につけることもできます。ただし、文字列の中での#はコメントとは見なされず、ハッシュ文字の”#”として判別されます。

print('test1')
print('test2') # print処理されます
print('test3#test4')
#print('test5')

print('test1')

print('test2') # print処理されます

print('test3#test4')

#print('test5')

1行目のprintは処理され「test1」と出力されます。

2行目のprintも#のコメントがprintの右側にあるためprint関数が処理され「test2」を出力されます。

3行目のprintの文字列に#が含まれますが、これは文字列として扱われるため「test3#test4」と主力されます。

4行目のprintは#の右側にあるため処理されず何も出力されません。

「”””～”””」（ダブルクォーテーションが3つ）、または、「”’～”’」（シングルクォーテーションが3つ）で囲まれている部分はコメントとして扱われます。

ただ、実際にはコメントではなくヒアドキュメントという複数行の文字列を表す構文です。文字列をただ書いているだけで処理がないためコメントと同様に扱われます。

途中に改行が含まれていても構いません。

用途としては関数のヘッダコメントや、一時的に複数行の処理をコメント化（コメントアウト）したい場合などに利用されます。

'''-----------------------------------------------
関数名：test
機能　：テスト
引数　：
-----------------------------------------------'''
print('abc')

'''-----------------------------------------------

関数名：test

機能　：テスト

引数　：

-----------------------------------------------'''

print('abc')

複数行コメントでは「”””」や「”’」の左にインデントを付けることができません。インデントがある場合はエラーになります。

次のページでは、Pythonプログラムで扱う変数について紹介します。