Pythonでのコメントアウトの書き方

Pythonでのコメントの書き方について説明します。

コメントはプログラムを書く上で非常に重要です。Pythonに限らず、記述したプログラムの意図をきちんと読み手(自分も含む)に伝えるためには、適切なコメントを書くことが不可欠です。プログラムの各部分について「どのような目的でコードを書いたか」を端的に表すコメントを書くようにしましょう。

コメントとは

コメントとはプログラムに関する注釈で、プログラムの可読性を高めるために日本語や英語等の自然言語で記述されます。コメントを適切に記述することによって、プログラムの意図が伝わりやすくなり、デバッグや保守をしやすくなります。また、プログラムがうまく動かない時など、原因個所を突き止めるためにプログラム中で一時的に実行させたくないコードをコメントとして記述することもあります。

行単位のコメント

Pythonでは行単位のコメントは#に続けて記述します。#以降は行の終わりまでコンピュータは無視し、実行されません。

# Hello, world!を表示する
print "Hello, world!"

複数行単位のコメント

Pythonでは複数行にまたがるコメントアウト記号はありませんが、プログラム中に記述された文字列は実行に影響を及ぼさないため、これを利用してクォーテーションを使って複数行単位のコメントを記述します。具体的には、'''(シングルクォーテーション3つ)あるいは"""(ダブルクォーテーション3つ)で囲まれた部分がコメントアウトされます。

'''
この行はコメント
この行もコメント
'''

ただし、クォーテーションを用いたコメントアウトではインデントに注意する必要があります。#はインデントなしで使うことができますが、クォーテーションを用いたコメントは必ず直前の行と同じインデントで記述しましょう。

for x in {1,2,3}:
    print "test"
'''
このコメントはエラー
'''
    print x

この例では、for文によって繰り返される処理のブロック外にコメント(文字列)が書かれているためにエラーとなってしまいます。以下のように適切にインデントをつけることで解決することができます。

for x in {1,2,3}:
    print "test"
    '''
    このコメントはOK
    '''
    print x

イベント

2017/10/06(金)
UX School(全10回)