PEP 8
04.06.2021
При оформлении программ мы будем использовать PEP 8 — Python Enhanced Proposal (неоф. перевод: Расширенное Предложение Python). Данный документ предлагает единый и общепринятый стиль написания программ на Python. Документ создан по рекомендациям автора Python, Гвидо Ван Россума. С PEP 8 на русском языке, вы можете ознакомиться по этой ссылке.
Некоторые рекомендации PEP 8
Рекомендация 1. Избегайте использования пробелов перед открывающей скобкой, после которой начинается список аргументов функции.
Правильно:
print('例えば')
# Иероглифы сверху переводятся как "Пример"print ('例えば')Рекомендация 2. После запятой нужен пробел.
Правильно:
print('さくら', '翠華')
# ^ ^
# Сакура ЦуйхуаНеправильно:
print('さくら','翠華')
Рекомендация 3. Не отделяйте пробелами знак «равно», когда он употребляется для обозначения параметра по умолчанию.
Правильно:
print('私の名', '前は', 'マコトです', sep='**', end='+')
# ^ ^ ^
# Меня зовут МакотоНеправильно:
print('私の名', '前は', 'マコトです', sep = '**', end = '+')Комментарии
До этого момента все, что мы набирали в тексте наших программ, представляло собой команды для компьютера. Но в программу также имеет смысл включать примечания, описывающие, что она делает и как работает. Это может помочь вам или кому-то другому понять принцип работы программы спустя некоторое время.
Такие примечания называются комментариями.
Однострочные комментарии
# (решетки). Давайте рассмотрим следующий код:
# これはコメントです
print('Python рулит!')
Если запустить эту программу, то получится:
Python рулит!# (решетки), предназначен только для автора программы и для тех, кто будет читать этот код. Комментарий в конце строки
print('Python рулит!') # これはコメントです <-- "Это комментарий" Комментарий начинается после символа # (решетки). Все, что будет находиться до этого символа, будет обычным кодом. Если запустить этот код, то получится:
Python рулит!Примечания
Согласно стандарту PEP 8, комментарии должны отделяться хотя бы двумя пробелами от кода. Они должны начинаться с символа # (решетки) и одного пробела.
Правильно:
# その後、テキストが印刷されます <-- "Далее будет выведен текст"
print('Комментарии в Python') # printコマンドを使用したテキストの出力 <-- "Вывод текста с помощью команды print"Неправильно
#その後、テキストが印刷されます
print('Комментарии в Python')#printコマンドを使用したテキストの出力Заключение
Сегодня мы узнали о стандарте PEP 8, о некоторых рекомендациях PEP 8 и как правильно оформлять комментарии в коде.
На этом пока все. Задавайте свои вопросы в комментариях или в форму обратной связи.
Выпускник ГБПОУ БКСМиПП, выпускник МАОУ Школа №75 г. Уфы, создатель виртуального вокалиста Даичи Акиба, ассистент Марины Николаевны с 5 октября 2020 г., волонтер-представитель Калининского общества инвалидов города Уфы с 07.06.2022 г., и там же оператор персональных данных с 01.09.2023 г.
Спасибо за информацию.
Изучаю язык программирования Python.
Интересные статьи на сайте. Задержался.