PEP 8 i dokumentation

Hittills har vi fokuserat på hur PEP 8 påverkar den funktionella delen av koden. Det finns även regler för att göra kommentarer och dokumentation mer lättlästa. I den här övningen får du rätta olika typer av kommentarer så att de följer PEP 8.

Resultatet av en stilkontroll med pycodestyle visas nedan.

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)

Den här övningen är en del av kursen

Mjukvaruutvecklingsprinciper i Python

Visa kurs

Övningsinstruktioner

Använd utdata från pycodestyle för att redigera kodens kommentarer så att de följer PEP 8.

Interaktiv övning med praktiskt arbete

Testa den här övningen genom att slutföra den här exempelkoden.

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)

Redigera och kör kod