5

edX.orgのオンラインCS188.1xクラスで使用されているコード（インストラクターによって作成されたコード）を確認しているときに、コメントとして使用するために一組の二重引用符（strの周りで使用する場合など）が繰り返し使用されていることに気付きました。

私はこれを前に見たことがなく、PEP8で私が見つけたとは述べられていませんが、確かにうまく機能しているようです。誰かが私を啓発できますか？

次に例を示します。

class SomeClass():
    """
    Some docstring info, using standard 'triple double quotes'
    """
    def  __init__(self):
        "This is the comment style to which I'm referring."
        some.code = foo      # Here's a normal inline comment

    def bar(self, item):
        "Here is another example of the comment style"
       return wtf
4

2 に答える 2

8

docstringは、クラス、メソッド、関数、またはモジュールの最初のステートメントとして表示される文字列リテラルです。様式的には、トリプルクォート形式を使用して、より長く、より適切にフォーマットされたdocstringを可能にし、簡単に参照できるように注意を喚起するのが一般的で好ましいですが、どの文字列でも修飾されます。

コメントはプログラムの実行にまったく関係がないため、Docstringはコメントとは異なりますが、Docstringは実行時にオブジェクトの__doc__変数にアクセスすることで利用できます。

于 2012-10-14T18:25:57.923 に答える
0

それはただのdocstringです。おすすめのデザインです。たとえば、そのクラスを Python シェルにロードする場合、a を呼び出すとhelp(bar)、"Here is another example of the comment style"

于 2012-10-14T19:10:30.493 に答える