PEP 8 в документации
До этого момента мы рассматривали, как стандарт PEP 8 влияет на функциональные части кода. Однако существуют и правила оформления комментариев и документации, которые делают код более читаемым. В этом упражнении вы исправите различные типы комментариев, чтобы привести их в соответствие с PEP 8.
Ниже показан результат проверки кода с помощью pycodestyle.
my_script.py:2:15: E261 at least two spaces before inline comment
my_script.py:5:16: E262 inline comment should start with '# '
my_script.py:11:1: E265 block comment should start with '# '
my_script.py:13:2: E114 indentation is not a multiple of four (comment)
my_script.py:13:2: E116 unexpected indentation (comment)
Это упражнение является частью курса
Принципы разработки программного обеспечения на Python
Инструкции к упражнению
- Используйте вывод
pycodestyle, чтобы отредактировать комментарии в коде и привести их в соответствие с PEP 8.
Интерактивное практическое упражнение
Попробуйте выполнить это упражнение, дополнив этот пример кода.
def print_phrase(phrase, polite=True, shout=False):
if polite:# It's generally polite to say please
phrase = 'Please ' + phrase
if shout: #All caps looks like a written shout
phrase = phrase.upper() + '!!'
print(phrase)
#Politely ask for help
print_phrase('help me', polite=True)
# Shout about a discovery
print_phrase('eureka', shout=True)