Python - コメント

公開日:2019-02-28 更新日:2019-05-14
[Python]

1. 概要

コメントについてです。
インラインコメントは # を使います。
ブロックコメントはありません。
但し、""" または ''' で囲って、代入先がない文字列をブロックコメントとして使うことができます。
インデントが必要な個所では、インデントする必要があるので要注意。

2. インラインコメント

# コメントです。

a = 1 # 代入します

3. ブロックコメント

"""
コメントです。
コメントです。
コメントです。
"""

ブロックコメントで使う記号を変えると、
ブロックコメントを入れ子にすることもできます。
ブロックコメントを含んだ関数などを、全てコメントにしたい場合に便利です。
'''
コメントです。

"""
コメントです。
コメントです。
コメントです。
"""

'''

4. インデントに関する注意

if などのインデントが必要な個所では、先頭行をインデントさせる必要があります。
if 1 == 1:
	"""
	コメントです。
	実際には文字列扱いのため、
	先頭行はインデントしないとエラーになります。
	"""
	print("OK")

5. ソースの先頭のコメントの取得

__doc__ で、ソースの先頭にあるコメントを取得できます。

# -*- coding: utf-8 -*-
"""
Created on Sat Feb 29 01:23:45 2020

@author: Test
"""

print(__doc__)

Created on Sat Feb 29 01:23:45 2020

@author: Test

6. ドックストリング

関数の下に """ を使ってブロックコメントを書くと、help(関数名) で内容が参照できたり、IDEによっては、カーソルを合わせた時に説明として表示されます。

def test():
"""
テスト用の関数です。
"""

help(test)

Help on function test in module __main__:

test()
テスト用の関数です。