6

__init__クラスdocstringに入れる情報と、メソッドdocstringに入れる情報を決定しようとしています。これまで、クラスの概要とその操作方法をクラスdocstringに入れてきましたが、初期化に直接関連するもの(引数の詳細など)は__init__docstringに入れました。

今日、これが正しい方法かどうか疑問に思い始めたので、いくつかの組み込みモジュールを調べましたが、この__init__メソッドにdocstringが含まれることはほとんどありません。PEP8によると、「非公開メソッドにはDocstringは必要ありません」が、 公開されていません__init__か?

__getitem__同じように、、、、__getattr__などの他の特別なメソッドについては、__new__docstringを使用する必要がありますか?それとも、それらがクラスdocstringに与える影響について言及する必要がありますか?

4

1 に答える 1

9

PEP 257から直接:

パブリックメソッド(__init__コンストラクターを含む)にもdocstringが必要です。

[...]

クラスコンストラクターは、その__init__メソッドのdocstringに文書化する必要があります。

于 2011-04-02T19:58:27.007 に答える