PEP 8 in documentatie

Tot nu toe hebben we ons gericht op hoe PEP 8 invloed heeft op functionele code. Er zijn ook regels die commentaar en documentatie beter leesbaar maken. In deze oefening maak je verschillende soorten commentaar PEP 8-conform.

Het resultaat van een pycodestyle-stijlcontrole op de code zie je hieronder.

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)

Deze oefening maakt deel uit van de cursus

Software-engineeringprincipes in Python

Cursus bekijken

Oefeninstructies

Gebruik de output van pycodestyle om de commentaarregels in de code aan te passen zodat ze voldoen aan PEP 8.

Praktische interactieve oefening

Probeer deze oefening eens door deze voorbeeldcode in te vullen.

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)

Code bewerken en uitvoeren