文件中的 PEP 8

到目前為止，我們著重在 PEP 8 如何影響可執行的程式碼部分。其實也有一些規則能讓註解與文件更易讀。在這個練習中，你要修正各式各樣的註解，讓它們符合 PEP 8。

下面是對這段程式碼執行 pycodestyle 風格檢查的結果：

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)

本練習屬於課程

Python 的軟體工程原則

檢視課程

練習說明

參考 pycodestyle 的輸出，編輯程式碼中的註解，讓它們符合 PEP 8。

動手互動練習

試著完成這個範例程式碼，體驗一下這個練習。

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)

編輯並執行程式碼