PEP 8
При оформлении программ мы будем пользоваться PEP 8 — Python Enhancement Proposal. Этот документ предлагает единый и общепринятый стиль написания программ на языке Python. Документ создан по рекомендациям Гвидо Ван Россума, автора Python. Прочесть его на русском языке можно по ссылке.
Некоторые рекомендации PEP 8
Рекомендация 1. Избегайте использования пробелов перед открывающей скобкой, после которой начинается список аргументов функции.
Правильно:
print('Follow PEP8!')
Неправильно:
print ('Follow PEP8!')
Рекомендация 2. После запятой нужен пробел.
Правильно:
print('PEP8', 'Rocks!')
Неправильно:
print('PEP8','Rocks!')
Рекомендация 3. Не отделяйте пробелами знак «равно», когда он употребляется для обозначения значения параметра по умолчанию.
Правильно:
print('My name', 'is', 'Python', sep='**', end='+')
Неправильно:
print('My name', 'is', 'Python', sep = '**', end = '+')
Комментарии
До этого момента всё, что мы набирали в тексте наших программ, представляло собой команды для компьютера. Но в программу имеет смысл включать также примечания, описывающие, что она делает и как работает. Это может помочь вам или кому-то другому понять принцип работы программы спустя некоторое время.
Такие примечания называются комментариями.
Однострочные комментарии
Любую строку можно превратить в комментарий, поместив перед ней символ #.
Рассмотрим следующий код:
print('Python rocks!')
Если запустить эту программу, то получится:
Python rocks!
Первая строка при запуске игнорируется. Комментарий, начинающийся с символа #, предназначен только для автора программы и для тех, кто будет читать этот код.
Комментарий в конце строки
Комментарий можно поместить после строки кода.
print('Python rocks!')
Комментарий начинается после символа #. Все, что находится до этого символа, представляет собой обычный код. Если запустить эту программу, получится:
Python rocks!
Примечания
Примечание 1. Согласно стандарту PEP 8, комментарии должны отделяться хотя бы двумя пробелами от кода. Они должны начинаться с символа # и одного пробела.
Правильно:
print('Comments in Python')
Неправильно:
print('Comments in Python')
Примечание 2. При вводе комментариев в среде Wing IDE вы обнаружите, что они выделяются цветом. Это сделано, чтобы облегчить чтение кода.