pep-ja/pep-0257.rst at master · whosaysni/pep-jadocstring とは、モジュール、関数、クラス、メソッドといったオブジェクトについて、その定義部分の最初の行に書く文字列リテラルのデータです。 定義した docstring は、そのオブジェクトの特殊属性 __doc__ になります。 原則として、モジュールには全て docstring を定義すべきです。 また、モジュールで公開している関数やクラスもまた、全て docstring を定義すべきです。 公開のメソッド (__init__ コンストラクタも含みます) にも、 docstring を持たせてください。 パッケージの場合、パッケージディレクトリの __init__.py ファイルの docstring でドキュメントを記述してもかまいません。 Python コード中で、上記以外の場所に、独立した文字列リテラルを置いた場合にも、ドキュメントになります。 Python のバイトコー
