python多行注释缩进

Question

我有一个Django项目，在某些地方我们有多行注释缩进如下：

field = models.IntegerField(default=0, null=True)  # 0-initial_email_sent
                                                   # 1-second_email_sent
                                                   # 2-third_email_sent

这显然违反了 PEP，但在我看来，这有助于提高可读性。当然，我可以这样评论：

# 0-initial_email_sent
# 1-second_email_sent
# 2-third_email_sent
field = models.IntegerField(default=0, null=True)

，但我更喜欢第一个。

有没有办法在不违反 PEP 8 的情况下缩进注释？

Answer 1

幻数是邪恶的，所以这里最好的文档是使用命名（伪）常量：

INITIAL_EMAIL_SENT = 0
SECOND_EMAIL_SENT = 1
THIRD_EMAIL_SENT = 2
field = models.IntegerField(default=INITIAL_EMAIL_SENT, null=True) 

作为一般规则，注释越少越好（清晰的代码不需要或很少注释）。

有关在何处放置注释（特别是多行注释）的更一般答案：

1. 在评论项之前有评论是大多数Python用户所期望的，所以对于大多数人来说，它是是“更具可读性”

2. 它还使代码编辑变得更容易（您不会将注释与代码混合，您不必维护注释缩进等）。

如果这是您自己的个人项目，并且您不打算共享它或让其他人参与其中，您（希望）可以自由使用任何编码风格/约定，pep08 不是宗教，但如果其他人必须工作在你的代码上他肯定会讨厌你这样评论。

Answer 2

这个问题与这个问题
重复 您还可以使用这样的多行注释。

"""
This is how yo can use Python Multi-line Comments
Line two is here.
Line three is here.
"""