概述
今天我开始想知道这是否是正确的方法,所以我看了几个内置模块,我发现__init__方法几乎从来没有文档字符串.根据PEP8,“非公开方法不需要文档字符串”,但是不公开__init__?
同样,如果__getitem __,__ getattr__或__new__等其他特殊方法应该有文档字符串呢?或者我应该只提一下他们在类docstring中的后果?
Public methods (including the __init__
constructor) should also have docstrings.
[…]
The class constructor should be documented in the docstring for its __init__
method.
总结
以上是编程之家为你收集整理的python – 把docstrings放在特殊方法上?全部内容,希望文章能够帮你解决python – 把docstrings放在特殊方法上?所遇到的程序开发问题。
如果您也喜欢它,动动您的小指点个赞吧