内联Python文档的行长度

时间:2012-10-24 12:48:20

标签: python coding-style documentation inline

在编写内联文档时,是否有一种标准的换行方法,当它出现较长的文本行时(显然这不应该经常发生)?

例如:

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

如果没有明确定义的标准或传统,我并不是真的在寻找辩论,在这种情况下,问题可能应该被关闭。但如果有标准或非常普遍的做法,我想知道它是什么。

2 个答案:

答案 0 :(得分:4)

对于像你问题中的例子那样的多用途评论,你也可以使用"""三重引号"""您的意见跨越换行符。

PEP 8样式指南建议

  

将所有行限制为最多79个字符

还有:

  

用于流动长文本块(文档字符串或注释),限制   建议长度为72个字符。

有关文档字符串的样式指南的特定部分,特定类型的内联文档,您可以找到here

答案 1 :(得分:0)

计算机世界中的行数通常限制为80个字符,PEP样式指南建议最多使用79个字符。