PEP 8 w dokumentacji
Do tej pory skupialiśmy się na tym, jak PEP 8 wpływa na funkcjonalne fragmenty kodu. Istnieją jednak również reguły dotyczące czytelności komentarzy i dokumentacji. W tym ćwiczeniu poprawisz różne rodzaje komentarzy tak, aby były zgodne z PEP 8.
Wynik sprawdzenia stylu przez pycodestyle jest widoczny poniżej.
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)
To ćwiczenie jest częścią kursu
Zasady inżynierii oprogramowania w Pythonie
Instrukcje do ćwiczenia
- Skorzystaj z wyników działania
pycodestyle, aby poprawić komentarze w kodzie i dostosować je do wymagań PEP 8.
Interaktywne ćwiczenie praktyczne
Spróbuj tego ćwiczenia, uzupełniając ten przykładowy kod.
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)