Pythonのコーディング標準05-基本仕様 - ドキュメンテーション文字列(ドキュメンテーション文字列)

ドキュメンテーション文字列仕様の基本的なポイント:

1、すべてのパブリックモジュール、関数、クラス、メソッド、ドキュメンテーション文字列を記述する必要があります。プライベートメソッドは必ずしも必要ありませんが、それはdefの後に説明するブロックコメントを提供する必要があります。

2、最後のドキュメント文字列。「」「これは一行だけをdocstringとしない限り、別の行にする必要があります。

「」「戻るfoob​​arの
オプションplotzは最初bizbazをfrobnicateすると言います。
『』」

『』「ONELINEドキュメンテーション文字列『』」

 

おすすめ

転載: www.cnblogs.com/mazhiyong/p/12504751.html