Python: コメントの書き方
コメントはプログラムの解説文の役割を果たし、 プログラムの実行時には無視されます。 ソースコードを読みやすくするには コメントを適切に入れてください。
コメントの手法はプログラミング言語によって異なります。
Pythonでコメントを書く場合は「#(シャープ)」記号を使います。
さらに複数行コメントとして「便宜的」に '''(シングルクォート3つ)や 、
"""(ダブルクォート3つ) を使うこともできます。
単一行コメント #
単一行コメントは #記号を使い、#記号から行末までをコメントとみなします。
行頭に#記号がある場合は、その行全部がコメントになります。
行の途中に#記号がある場合は、途中からコメントになります。
# 行頭に書く場合 a = 0 # 途中に書く場合
ただし次のサンプルコードからわかるように、 文字列中の#記号は、 コメント記号ではなく文字の1つとして認識されます。
s = "文字列中の#はコメント記号ではない"
print(s)
# 実行結果
文字列中の#はコメント記号ではない
複数行コメント
Pythonでは複数行コメントの記号は規定されていません。 ですが下のように '''(シングルクォート3つ)や """(ダブルクォート3つ)を使って文字列を作成し、 それをコメントとみなすこともできます。
"""
この部分が
複数行コメントになります。
"""
'''
この部分も
複数行コメントになります。
'''
但し、シングルクォートやダブルクォートを使った 複数行コメントの手法は、 あくまでも「便宜的」な使い方で、正式なコメント手法ではありません。 コメントはできるだけ 「#(シャープ)」記号を使うことをおすすめします。
# 複数行の場合も # このように#記号を使った # コメントアウトをおすすめします。
docstring
docstringとは、自分で作成したモジュールやクラス、関数などに付ける説明文のことです。 モジュールやクラス、関数の先頭に「"""」ダブルクォート3つで囲った記述部分が docstringとしてみなされます。説明文は複数行にわたっても構いません。
def test():
"""ここに関数test()の説明文を書く"""
処理部分