Python Docstrings 中包含什么？ [复制]

Question

我想知道 python 文档字符串包括哪些内容？比如如果我想记录某个类，我应该在该类的文档字符串中写什么？

Answer 1

根据PEP 257 -- Docstring Convention：

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

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