python - 超过 79 个字符与评论一致
问题描述
当我有例如这条线时,我应该怎么做:
full_path = "https://www.google.cz/search?q=" + website_keywords # google link url
Flake8 报告我,该行中的字符最多超过 79 个。长度。那么,当 PEP 8 说 inline-comment 应该与特定语句在同一行时,我应该如何处理评论。
解决方案
通常可以在行上方添加这样的注释:
# google link url
full_path = "https://www.google.cz/search?q=" + website_keywords
顺便说一句,在撰写本文时,PEP 8 表示评论的行数限制仅为 72。
对于结构限制较少的长文本块(文档字符串或注释),行长应限制为 72 个字符。
...
一些团队非常喜欢更长的线路长度。对于可以就此问题达成协议的团队专门或主要维护的代码,可以将标称行长度从 80 个字符增加到 100 个字符(有效地将最大长度增加到 99 个字符),前提是注释和文档字符串仍然被包装72 个字符。
目前尚不清楚这是否适用于内联注释,因为它们不是“长文本块”,但 PEP 8 也说,
内联注释是不必要的,如果它们陈述明显的话,实际上会分散注意力。
您可能会考虑完全删除该评论。考虑到字符串中包含“google”,它是 Google URL 的事实是显而易见的。
在一种情况下,评论确实必须与评论内容在同一行——PEP -484 类型的评论。在这种情况下,您使用括号:
full_path = (
"https://www.google.cz/search?q=" + website_keywords
) # type: str
推荐阅读
- grafana - 如何解决 Grafana 面板插件中的 jsdoc PluginConflictError?
- ios - react-native run-ios 无法连接到开发服务器 npm:'7.19.1' 和节点:16.6.0,macincloud.com 环境
- javascript - React 中的 createContext/useContext 未按预期工作
- r - 在 R 中查找与表嵌套结构表的交集
- graphql - Prisma Schema 中的多态性 - 最佳实践?
- wordpress - 在 Wordpress 自定义帖子类型上添加多条件搜索引擎
- java - PSQLException:发送到后端时发生 I/O 错误。...引起:java.io.EOFException
- javascript - 引导导航栏中的活动链接名称不会改变颜色
- shell - 如何在shell脚本中调用字符串作为变量?
- python - 在 pandas 中使用 Apply 函数