Dokümantasyonda PEP 8

Şimdiye kadar PEP 8'in kodun işlevsel kısımlarını nasıl etkilediğine odaklandık. Yorumları ve dokümantasyonu daha okunabilir kılmaya yardımcı olan kurallar da var. Bu egzersizde, farklı türdeki yorumları PEP 8'e uygun hale getireceksin.

Koddaki pycodestyle stil kontrolünün sonucu aşağıda görülebilir.

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)

Bu egzersiz

Python'da Yazılım Mühendisliği İlkeleri

kursunun bir parçasıdır

Kursu Görüntüle

Egzersiz talimatları

pycodestyle çıktısından yararlanarak kodun yorumlarını düzenle ve PEP 8 ile uyumlu hale getir.

Uygulamalı interaktif egzersiz

Bu örnek kodu tamamlayarak bu egzersizi bitirin.

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)

Kodu Düzenle ve Çalıştır