Python Docstrings中包含哪些内容？

Question

我想知道python docstrings包含哪些内容？就像我想要记录某个类一样，我应该在该类的docstring中写什么东西？

Answer 1

根据PEP 257 -- Docstring Convention：

  

类的docstring应该总结其行为并列出   公共方法和实例变量。如果是这样的课程   子类，并有一个额外的子类接口，这个   接口应单独列出（在docstring中）。班级   构造函数应记录在其__init__的docstring中   方法。个别方法应由他们自己记录   文档字符串。

     

如果一个类是另一个类的子类，而且它的行为主要是   继承自该类，其文档字符串应该提到这个和   总结差异。使用动词“覆盖”来表示a   子类方法替换超类方法而不调用   超类方法;使用动词“extend”来表示一个子类   方法调用超类方法（除了它自己的行为）。