PEP 8 nella documentazione
Finora ci siamo concentrati su come PEP 8 influisce sulle parti funzionali del codice. Esistono anche regole che rendono più leggibili commenti e documentazione. In questo esercizio sistemerai vari tipi di commenti per renderli conformi a PEP 8.
Di seguito puoi vedere il risultato del controllo di stile pycodestyle sul codice.
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)
Questo esercizio fa parte del corso
Principi di Ingegneria del Software in Python
Istruzioni dell'esercizio
- Usa l’output di
pycodestyleper modificare i commenti del codice e renderli conformi a PEP 8.
Esercizio pratico interattivo
Prova a risolvere questo esercizio completando il codice di esempio.
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)