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

Question

似乎有两个地方可以放置类的文档字符串:

1. 右下类定义:

   class MyClass:
       """Summary of MyClass.
   
       Body.
       """
   

2. 在 __init__ 构造函数下:

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

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

Answer 1

它们可以同时存在，因为它们的目的不同。

The docstring for a class should summarize its behavior and list the public methods and instance variables. If the class is intended to be subclassed, and has an additional interface for subclasses, this interface should be listed separately (in the docstring). The class constructor should be documented in the docstring for its __init__ method. Individual methods should be documented by their own docstring.

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