【簡単】Pythonコメントの2種類の書き方

# を使う

Pythonスクリプトでは、一般的に「#」から行末までがコメント扱いになります。

variable = value  # comment

コメントは処理上無視されます。

a = "A"  # a = "B"

このような事をしても a に “B” は代入されません。

コメントは、行頭から書くこともできます。その場合は、行の初めに「#」を書きます。

a = "AAA"
# comment

IDEとしてVSCodeを使っている場合、行を複数選択してから ctrl + k + c を入力すると、すべてコメントアウトすることができます。

print(a)
print(b)
print(c)

print(a)からprint(c)を選択状態にして ctrl + k + c を入力すると、

# print(a)
# print(b)
# print(c)

こうなります！これは結構便利でよく使いますね。

関数やクラスの説明を記載するコメントとしてドキュメンテーション文字列があります。
シングルクォーテーション(‘)、ダブルクォーテーション(“)のどちらかを、コメントの両端に3つずつ書きます。これをトリプルクォートと呼びます。

def function(input):
    '''
    description
    ---
    ---
    '''
    a = b

このように書きます。トリプルクォート間には何行コメントを書いても全てコメント（文字列）扱いになります。

注意点として、トリプルクォートは正確にはコメントではなく文字列です。
インデントを守らないとエラーとなってしまいます。

def function(input):
'''
description
---
---
'''
    a = b

これはインデントを守っていない例です。