您好, 欢迎来到 !    登录 | 注册 | | 设为首页 | 收藏本站

python – 把docstrings放在特殊方法上?

5b51 2022/1/14 8:22:47 python 字数 1502 阅读 574 来源 www.jb51.cc/python

我正在尝试决定在类docstring中放入什么信息以及在__init__方法docstring中放入什么.到目前为止,我已经在类docstring中对类进行了概述以及如何使用它,而与初始化(参数详细信息等)直接相关的东西我放入了__init__ docstring. 今天我开始想知道这是否是正确的方法,所以我看了几个内置模块,我发现__init__方法几乎从来没有文档字符串.根据PEP8,“非公开

概述

今天我开始想知道这是否是正确的方法,所以我看了几个内置模块,我发现__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放在特殊方法上?所遇到的程序开发问题。


如果您也喜欢它,动动您的小指点个赞吧

除非注明,文章均由 laddyq.com 整理发布,欢迎转载。

转载请注明:
链接:http://laddyq.com
来源:laddyq.com
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。


联系我
置顶