【Python入門#02】コメントの書き方を理解しよう

・なぜコメントするのでしょうか？

自分の書いたプログラムを他の人が見て、分かりづらいといったことがよくあります。そうならないために読みやすくするメモとして利用します。

・コメントとは？

コメントとはプログラムに関する注釈で、プログラムの可読性を高めるために記述します。コメントを適切に記述することによって、プログラムの意図が伝わりやすくなり、デバッグや保守をしやすくなります。

・1行コメント

Pythonでは行単位のコメントは、『#』を先頭につけて記述します。
※『#』を先頭につけなければエラーになります
※『#』の後に半角スペースを1つ空けると読みやすくなります

『#』を先頭につけてコメント化することをコメントアウトといいます。

# xに"Python"を代入しています
x = "Python"

・行の途中でコメント

行の途中に記述するコメントを『インラインコメント』といいます。

x = "Python" # xに"Python"を代入しています

・複数行コメント

コーディングをしていると『プログラムの○○行ほどコメントアウトしたい』という事があります。
『#』を○○個挿入すればいいのですが、数が多くなると非常に面倒くさいことになります…。

そんなときに、『シングルクォーテーション3つ（'''）』または『ダブルクォーテーション3つ（"""）』で囲むことで、コメントアウトすることができます。

'''
a = 1  # 数値
b = "Python" # 文字列
ｃ = [1, 2, 3] # 文字列
'''

・コメントの注意点

・行の途中でコメント

下記のように、2つ目の『#』を記述するとエラーになります。

x = "Python" # xに"Python"を代入しています # Pは大文字です

下記のように『#』は1つで記述しましょう！

x = "Python" # xに"Python"を代入しています（Pは大文字です）

・複数行コメント

下記のように、『シングルクォーテーション』のインデントがずれているとエラーになります。

    '''
a = 1  # 数値
b = "Python" # 文字列
ｃ = [1, 2, 3] # 文字列
    '''

下記のようにインデントを揃えましょう！

'''
a = 1  # 数値
b = "Python" # 文字列
ｃ = [1, 2, 3] # 文字列
'''