2012-10-24 27 views
0

在編寫內聯文檔時,是否有一個換行符的標準方法,當它涉及更長的文本行時(很明顯,這不應該發生得太頻繁)?內聯Python文檔的行長度

例如:

 
"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" 

或者它應該是:

 
"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" 

如果沒有明確的標準或傳統,爲了這個,我真的不想找一個辯論,在這種情況下,這個問題可能應該是封閉的。但是如果有標準或非常普遍的做法,我想知道它是什麼。

回答

4

對於您的問題中的示例中的多註釋,您還可以使用「」「三重引號」「」作爲您的註釋跨越換行符。

PEP 8風格指南建議

限制所有線路爲最多79個字符

而且也:

對於流動大段文字(文檔字符串或註釋) ,建議將 長度限制爲72個字符。

有風格指南的有關文檔字符串的特定部分,特定類型的內聯文檔,你可以找到here的。

0

在計算機世界中線條通常限制爲80個字符,PEP風格指南建議最多79個。