オプション2:複数行の文字列をコメントとして使用する
Pythonで”適切な”複数行コメントを書くためのもう一つのオプションは、"""
構文で複数行の文字列を使用することです。 ここに例があります:
"""This is a "block comment" in Python, madeout of a mult-line string constant.This actually works quite well!"""answer = 42
ご覧のとおり、三重引quotedで囲まれた文字列を使用して、Pythonで複数行のコメントに似たものを作成できます。, 最初のインデントを確認するだけです"""
正しく、そうでなければSyntaxError
。 たとえば、このテクニックで関数内でブロックコメントを定義したい場合は、次のようにする必要があります。
このテクニックでは”真の”コメントは作成されないことに注意してください。 これは単に何もしないテキスト定数を挿入するだけです。 これは、コードのどこかに通常の単一行文字列を挿入し、それにアクセスしないことと同じです。,
ただし、このような孤立した文字列定数はバイトコードには表示されず、効果的に複数行のコメントに変換されます。 未使用の文字列がCPythonバイトコードの逆アセンブリに表示されないという証拠は次のとおりです。
ただし、これらの”コメント”をコード内に配置する場所には注意してください。, 文字列が関数シグネチャ、クラス定義、またはモジュールの先頭の直後に続く場合、Pythonではまったく異なる意味を持つdocstringに変わります。
Docstrings(“documentation strings”)人間が読めるドキュメントをPythonのモジュール、関数、クラス、およびメソッドに関連付けることができます。 これらはソースコードのコメントとは異なります。
コメントはパーサーによって削除されますが、docstringはバイトコードで終わり、文書化されたオブジェクトに関連付けられます。 でもアクセスプログラムを行います。,
前に言ったように、pythonでパーサーによって無視される”真の”複数行コメントを取得する唯一の方法は、複数の#
単一行コメント。
私はこの”偽の”ブロックのコメントスタイルがPythonの作成者であるGuido van Rossumによって承認されたことに少し驚いたことを認めます: