跳到内容

多个前导哈希的块注释 (E266)

源自 pycodestyle linter。

修复总是可用的。

此规则不稳定且处于预览状态。使用需要 --preview 标志。

作用

检查以多个前导 # 字符开头的块注释。

为什么这不好?

根据 PEP 8,“块注释通常由一个或多个由完整句子构成的段落组成,每个句子以句点结尾。”

块注释的每一行应以 # 开头,后跟一个空格。

Shebangs(以 #! 开头,位于文件顶部)不受此规则的约束。

示例

### Block comment

建议改为

# Block comment

或者,此规则对仅由 # 字符组成的注释进行例外处理,例如

##############
# Block header
##############