Как правильно добавить длинный комментарий к заявлению в 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, просто аккуратно вставив определенные c ключевые слова, чтобы объяснить это, вместо использования правильного предложения Engli sh.

Но, если у вас должно быть длинное описание, вы можете разбивать комментарии в несколько строк.

""" 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.