0

When writing inline documentation, is there a standard method for line breaks when it comes longer lines of text (Obviously this shouldn't happen too frequently)?

For example:

"This modules does blah blah blah blah blah blah blah blah blah blah blah blahblah blah blah blah blah blahblah blah blah blah blah blahblah blah blah blah blah blah"

Or should it be:

"This modules does blah blah blah blah blah blah blah blah blah blah blah 
blahblah blah blah blah blah blahblah blah blah blah blah blahblah blah 
blah blah blah blah"

If there is no well defined standard or tradition for this I'm not really looking for a debate, in which case the question should probably just be closed. But if there is a standard or very common practice I would like to know what it is.

4

2 に答える 2

4

質問の例のような複数のコメントの場合、コメントに"""トリプル引用符"""を使用して改行にまたがることもできます。

PEP8スタイルガイドは

すべての行を最大79文字に制限します

そしてまた：

テキストの長いブロック（docstringまたはコメント）を流すには、長さを72文字に制限することをお勧めします。

docstringに関するスタイルガイドの特定のセクション、特定のタイプのインラインドキュメントがあり、ここで見つけることができます。

于 2012-10-24T12:52:51.660 に答える
0

コンピュータの世界では通常、行は80文字に制限されており、PEPスタイルガイドでは最大79文字を推奨しています。

于 2012-10-24T12:53:37.143 に答える