Top.Mail.Ru
Ответы

Не могу разобраться с длинной комментариев согласно PEP8

В PEP8 говорится, что предпочтительная длина строки кода должна быть 79 символов, а длина комментариев - 72 символа. Я не могу понять, почему длина комментариев всего 72 символа, если есть место для ещё 9-ти, или имеется ввиду общая длина комментариев?

Я предоставил 5 вариантов, какой из них вы считаете более подходящим под PEP8?

Дополнен

РЕШЕНО: подходит 1-ый и 4-ый вариант. Т.е., если комментарий начинается в начале строки, то его длина не более 72-х символов (если он длиннее, то просто переносим на следующие строки так же до 72-х символов включительно). Если комментарий начинается в строке с кодом, то разрешено его писать до 79-го символа включительно (если он длиннее, то просто переносим на другие строки и ограничиваем 72-ым, либо последним символом этого комментария на вышестоящей строке)

По дате
По рейтингу
Аватар пользователя
Новичок

Какая разница, что написано в наборе рекомендаций, называемом PEP8? PEP8 - не стандарт и не требования, а всего лишь благие пожелания, не имеющие никакой силы. Более того, если в компании, куда ты устроишься работать, есть собственный корпоративный Code Style, то любые рекомендации PEP8, ему противоречащие, идут лесом.

79 символов - религиозная мантра, бездумно повторяема со времён перфокарт и текстовых дисплеев. Ну а 72 символа - это тараканы в головах авторов PEP8.

В современном мире, где строка в окне IDE в ширину превышает 120 символов, ориентироваться на 79 символов по меньшей мере странно.

А что касается комментариев, то русский текст чаще всего длиннее аналогичного английского. И если английские комментарии более-менее удастся впихнуть в 72 символа, то с русскими проблем будет куда больше.

Аватар пользователя
Искусственный Интеллект

длина строки кода должна быть 79 символов

Включая комментарий. Который можно переносить с отступом на след строку.

длина комментариев - 72 символа

Если он начинается сразу с начала строки

Аватар пользователя
Просветленный

PEP8 рекомендует ограничивать длину комментариев и документации 72 символами
Если комментарий является фразой или предложением, первое слово должно быть написано с большой буквы, если только это не имя переменной, которая начинается с маленькой буквы
Предоставленные варианты комментариев не противоречат PEP8. Однако, варианты 2, 3 и 5 более подходят под рекомендации PEP8, так как они являются более читаемыми и удобными для восприятия