Pythonでは、最初にアンダースコアを付けて内部関数/プライベートメソッドを指定します。これらの関数はdocstringsで文書化する必要がありますか（必須ですか？）？（私が意味する正式なドキュメントであり、コードリーダーがコードを理解するのに役立つドキュメントではありません）これの一般的な方法は何ですか？
9605 次
1 に答える
39
Lo、私はPEP 8から引用します。その賢明な言葉は法律と見なされるべきです。このトピックについて、PEP 8 は次のように述べています。
- すべてのパブリック モジュール、関数、クラス、およびメソッドの docstring を記述します。Docstrings は非パブリック メソッドには必要ありませんが、メソッドの機能を説明するコメントが必要です。このコメントは、「def」行の後に表示する必要があります。
于 2011-10-07T12:44:54.800 に答える