如何在 Python 中正确地为语句添加长注释？

Question

我正在尝试在我的项目中遵循PEP-8 。
例如，有一些语句应该有很长的注释（所以现在行长度超过 79 个字符）：

    fields_to_display = ['id', 'order_item']  # set here a list of fields to display when something happens somewhere

在PEP-8中，我们读到：

内联注释是与语句在同一行上的注释。

所以我想我应该使用内联注释。 如果是这样，我应该如何使它适合79 characters restriction ？

Answer 1

是的，您应该尝试通过仔细放置特定关键字来解释它，而不是使用正确的英文句子，从而使所有行都适合79 chars 。

但是，如果您必须有很长的描述，您可以将注释分成多行。

""" Multi-line comment used 
here for my code. """

好吧， PEP-8还说，

内联注释是不必要的，实际上如果它们明显地分散注意力的话。

因此，最好在方法定义下使用docstrings来解释方法，而不是将其放在每一行上。 像这样的东西：

def greet(name):
    """
    This function greets to
    the person passed in as
    a parameter
    """
    print("Hello, " + name + ". Good morning!")

Answer 2

我想您可以尝试将评论分成多行。 这样您就可以解决实际的79 chars规则。