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

发布时间：2020-12-16 23:20:38 所属栏目：Python 来源：网络整理

导读：我正在尝试决定在类docstring中放入什么信息以及在__init__方法docstring中放入什么.到目前为止,我已经在类docstring中对类进行了概述以及如何使用它,而与初始化(参数详细信息等)直接相关的东西我放入了__init__ docstring. 今天我开始想知道这是否是正确的

我正在尝试决定在类docstring中放入什么信息以及在__init__方法docstring中放入什么.到目前为止,我已经在类docstring中对类进行了概述以及如何使用它,而与初始化(参数详细信息等)直接相关的东西我放入了__init__ docstring.

今天我开始想知道这是否是正确的方法,所以我看了几个内置模块,我发现__init__方法几乎从来没有文档字符串.根据PEP8,“非公开方法不需要文档字符串”,但是不公开__init__？

同样,如果__getitem __,__ getattr__或__new__等其他特殊方法应该有文档字符串呢？或者我应该只提一下他们在类docstring中的后果？

解决方法

直接从 PEP 257：

Public methods (including the __init__ constructor) should also have docstrings.

[…]

The class constructor should be documented in the docstring for its __init__ method.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!