PEP 8 dalam dokumentasi

Sejauh ini kita berfokus pada bagaimana PEP 8 memengaruhi bagian kode yang fungsional. Ada juga aturan untuk membuat komentar dan dokumentasi lebih mudah dibaca. Pada latihan ini, Anda akan memperbaiki berbagai jenis komentar agar sesuai dengan PEP 8.

Hasil pemeriksaan gaya pycodestyle pada kode dapat dilihat di bawah ini.

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)

Latihan ini adalah bagian dari kursus

Prinsip Rekayasa Perangkat Lunak di Python

Lihat Kursus

Petunjuk latihan

Manfaatkan keluaran pycodestyle untuk mengedit komentar di kode agar sesuai dengan PEP 8.

Latihan interaktif praktis

Cobalah latihan ini dengan menyelesaikan kode contoh berikut.

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)

Edit dan Jalankan Kode