我正在尝试决定将哪些信息放入类文档字符串中以及将哪些信息放入__init__
方法文档字符串中。到目前为止,我一直在对类以及如何在类文档字符串中使用它进行概述,而与初始化直接相关的内容(参数详细信息等)我放在__init__
文档字符串中。
今天我开始怀疑这是否是正确的方法,所以我查看了几个内置模块,我发现该__init__
方法几乎没有文档字符串。根据 PEP8,“非公共方法不需要文档字符串”,但不是 __init__
公共的吗?
同样,其他特殊方法,比如__getitem__
,__getattr__
or __new__
,它们应该有文档字符串吗?或者我应该只提他们在类文档字符串中的后果吗?