草庐IT

python - 对类和 __init__ 文档字符串中应记录的内容是否达成共识?

我没有找到任何关于应该在类和__init__文档字符串中记录什么的最佳实践。有时我发现构造函数参数已经记录在类文档字符串中,有时在__init__文档字符串中进行了描述。我更喜欢在类文档字符串中描述构造,因为这是您在创建新实例时所调用的。但是应该在__init__方法文档字符串中记录什么?编辑:我知道googlestyleguide和googledocstringstyleexample,但两者都没有回答我的问题。文档字符串样式示例确实说The__init__methodmaybedocumentedineithertheclassleveldocstring,orasadocstri