Python的PEP8行长度限制是否适用于评论?

时间:2017-10-21 13:45:44

标签: python pep8

我正在开发一个协作的Python项目。由于PEP8,我的IDE(PyCharm)标记了长度超过120个字符的代码行的“小问题”。然而,这只发生在我有一个大的注释解释一些复杂的代码时 - 代码本身永远不会超过限制。我是否应该将这些长评论转化为多行评论以遵守指南或保留原样?

1 个答案:

答案 0 :(得分:3)

是的,指南适用于来源中的所有行,包括评论。那是因为它们有助于设定编辑器宽度的期望值。如果行长度建议不适用于注释,您仍然需要滚动编辑器窗口才能阅读注释。

PEP8仍然是一个指导方针,而不是严格的法治,你可以随意忽略它。我建议在与更多人合作的任何地方坚持使用它,即使你们都拥有更宽的屏幕。就个人而言,我喜欢能够并排放置多个编辑器标签,例如。

在Facebook,我们使用flake8-bugbear soft - 强制行长度,容差为10%:

  

B950:行太长了。这是pycodestyle的E501的实用等价物:它考虑了“max-line-length”,但仅在超过10%的值时触发。您将不再被迫重新格式化代码,因为右括号是一个字符太远而无法满足linter。同时,如果您明显违反了行长,您将收到一条消息,说明实际限制是多少。这是受到Raymond Hettinger的“超越PEP 8”谈话和高速公路巡逻的启发,如果你开车的话,不会阻止你。 5mph太快了。禁用E501以避免重复警告。

Oblig免责声明:我参与了flake8-bugbear。