类或 __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