类或__init__构造函数中的文档字符串？

Question

您似乎可以在两个地方放置类的文档字符串：

1. 在类定义的右边：

class MyClass(object):
     """ Summary of MyClass

     Body

     ...
     """

1. 在__init__构造函数下：

...
    def __init__(self, arg1, arg2):
        """ Summary of MyClass

        Body

        ...
        """

首选哪个？还是两者都可以？

Answer 1

它们都可以存在，因为它们都旨在用于不同的事物。

  

类的文档字符串应总结其行为，并列出公共方法和实例变量。如果该类打算被子类化，并且具有子类的附加接口，则应列出此接口单独（在文档字符串中）。 应将类构造函数的__init__方法记录在文档字符串中。各个方法应使用自己的文档字符串来记录。

强调我的。 此引用来自PEP 257 -- Docstring Conventions