3

我有一个 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 的情况下缩进评论？

4

2 回答 2

4

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

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 不是宗教，但如果其他人不得不从事你的代码他肯定会讨厌你这样评论。

于 2016-06-29T12:02:37.570 回答
0

这个问题是这个问题的重复你
也可以使用这样的多行注释。

"""
This is how yo can use Python Multi-line Comments
Line two is here.
Line three is here.
"""
于 2016-06-29T11:44:47.427 回答