【Python】コメントアウト(単数行/複数行)の書き方について解説！

コメントアウトとはプログラムに関するメモ書きのようなものであり、書き方が異なりますがどのプログラミング言語にもあります。

しかし、Pythonに限らず、記述したプログラムの意図をきちんと第三者に理解してもらうためには、メモを書くことが必要です。
プログラムの各部分について「どのような目的でコードを書いたか、このコードはどこの役割なのか」などコメントを残すようにしましょう。

また、コメントアウトは単数行だけでなく、複数行をまとめて行うこともできます。

今回はPythonでのコメントアウトの書き方について解説していきます。

⚫︎ コメントアウトとは

⚫︎ コメントアウト(単数行/複数行)の書き方

コメントアウトとは

コメントアウトとはプログラムに関するメモ書きであり、日本語や英語等の自然言語で記述することができます。

その為、プログラムの意図が伝わりやすくなり、第三者の方でも理解できるようになったり、デバッグや保守をしやすくなります。

また、コードを書いている最中に気になったところやプログラム中で一時的に実行させたくないコードをコメントとしてメモのような感じで残すこともあります。

コメントアウト(単数行/複数行)の書き方

単数行でコメントアウトする場合

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

例

num = 45 # 50

# numの値が偶数か奇数か判定
if num % 2 == 1:
    print('numの値は奇数である')
else:
     print('numの値は偶数である')

num = 45 # 50

# numの値が偶数か奇数か判定

if num % 2 == 1:

print('numの値は奇数である')

else:

print('numの値は偶数である')

出力結果

numの値は奇数である

#の後ろに記述することで、単数行のコメントアウトを行っています。

複数行でコメントアウトする場合

複数行でコメントアウトする場合は”'(シングルクォーテーション3つ)あるいは”””(ダブルクォーテーション3つ)を使用します。

例

'''
num = 45 # 50

# numの値が偶数か奇数か判定
if num % 2 == 1:
    print('numの値は奇数である')
else:
     print('numの値は偶数である')
     
'''

list1 = [3, 4, 5, 6, 7 ,8]

for i in list1:
    print(i)

'''

num = 45 # 50

# numの値が偶数か奇数か判定

if num % 2 == 1:

print('numの値は奇数である')

else:

print('numの値は偶数である')

'''

list1 = [3, 4, 5, 6, 7 ,8]

for i in list1:

print(i)

出力結果

3
4
5
6
7
8

「”’」のようにクォーテーションを3つ使用することで複数行でコメントアウトすることができます。

しかし、複数行でコメントアウトを行う場合はインデントに注意してください。

単数行の場合はインデントに関わらず、コメントアウトしたい時に「#」を使用すれば良いですが、複数行の場合はクォーテーションで囲む必要があるので
インデントに気をつけないと、関係ないところまでコメントアウトされエラーになってしまいます。

例

num = 45 # 50

# numの値が偶数か奇数か判定
if num % 2 == 1:
'''
奇数の場合の処理
'''
    print('numの値は奇数である')
else:
'''
偶数の場合の処理
'''
     print('numの値は偶数である')

num = 45 # 50

# numの値が偶数か奇数か判定

if num % 2 == 1:

'''

奇数の場合の処理

'''

print('numの値は奇数である')

else:

'''

偶数の場合の処理

'''

print('numの値は偶数である')

出力結果

IndentationError: expected an indented block

この場合、正常にプログラムが実行されると思いがちですが、if文のブロック外にコメントアウトされているためエラーとなっています。
その為、以下のようにインデントを意識してコメントアウトする必要があります。

例

num = 45 # 50

# numの値が偶数か奇数か判定
if num % 2 == 1:
    '''
    奇数の場合の処理
    '''
    print('numの値は奇数である')
else:
    '''
    偶数の場合の処理
    '''
    print('numの値は偶数である')

num = 45 # 50

# numの値が偶数か奇数か判定

if num % 2 == 1:

'''

奇数の場合の処理

'''

print('numの値は奇数である')

else:

'''

偶数の場合の処理

'''

print('numの値は偶数である')

出力結果

numの値は奇数である

このようにインデントを意識してコメントアウトすると、正しくコードが実行されます。

その為、必ず直前の行と同じインデントで記述しましょう。

今回のポイント

コメントアウトとはプログラムに関するメモ書きのようなもの

⚫︎ プログラムに関するメモ書きのようなものであり、他のプログラミング言語にもある

⚫︎ 単数行でコメントアウトする場合は「#」に続けて記述する

⚫︎ 複数行でコメントアウトする場合は”'(シングルクォーテーション3つ)あるいは”””(ダブルクォーテーション3つ)を使用する

⚫︎ 複数行でコメントアウトする際にはインデントを意識する
(インデントを意識しないと、関係ないところまでコメントアウトされエラーになる)

Writer

株式会社flyhawkのSTです。フライテックメディア事業部でのメディア運営・ライター業務なども担当。愛機はMac Book AirとThinkPad。好きな言語：swift、JS系(Node.js等)。好きなサーバー：AWS。受託開発やプログラミングスクールの運営をしております。ご気軽にお問い合わせください。

【Python】frozenset型とは？使い方について解説！

【Python】pop()でリスト(List)などで指定した要素を取り除く！