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)
Ця вправа є частиною курсу
Принципи Software Engineering у 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)