PEP 8 în documentație
Până acum ne-am concentrat pe modul în care PEP 8 afectează părțile funcționale ale codului. Există însă și reguli care ajută la îmbunătățirea lizibilității comentariilor și a documentației. În acest exercițiu, vei corecta diferite tipuri de comentarii pentru a fi conforme cu PEP 8.
Rezultatul verificării stilului cu pycodestyle poate fi văzut mai jos.
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)
Acest exercițiu face parte din cursul
Principii de inginerie software în Python
Instrucțiuni pentru exercițiu
- Folosește rezultatul generat de
pycodestylepentru a edita comentariile din cod și a le face conforme cu PEP 8.
Exercițiu interactiv practic
Încearcă acest exercițiu completând acest cod de exemplu.
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)