我正在从事一个协作 Python 项目。由于 PEP8,我的 IDE (PyCharm) 将超过 120 个字符的代码行标记为“小问题”。然而,这只发生在我有一个解释一些复杂代码的大注释时 - 代码本身永远不会超过限制。我应该将这些长注释转换为多行注释以遵守准则还是保持原样?
是的,指南适用于源代码中的所有行,包括注释。那是因为它们有助于设定对编辑器宽度的期望。如果行长建议不适用于注释,您仍然需要滚动编辑器窗口才能阅读注释。
PEP8 仍然是一个指南,不是严格的法治,你可以随意忽略它。我建议在与更多人合作的任何地方坚持使用它,即使你们都有更宽的屏幕。例如,就我个人而言,我喜欢能够并排放置多个编辑器选项卡。
在Facebook上,我们使用flake8-bugbear到软-enforce线的长度,用10%的公差:
B950:线路太长。这是 pycodestyle 的 E501 的实用等价物:它考虑“max-line-length”,但仅在超过 10% 的值时才触发。由于右括号太远而无法满足 linter,您将不再被迫重新格式化代码。同时,如果您确实严重违反了线路长度,您将收到一条消息,说明实际限制是多少。这是受到 Raymond Hettinger 的“Beyond PEP 8”谈话和高速公路巡逻的启发,如果您以低于 5mph 的速度行驶太快,则不会阻止您。禁用 E501 以避免重复警告。
义务免责声明:我为 flake8-bugbear 做出了贡献。
| 归档时间: |
|
| 查看次数: |
2434 次 |
| 最近记录: |