從0開始的Python學習010return語句&DocStrings

return語句

return語句用來從一個函數中 返回 即跳出函數。當然也可以從函數中返回一個值。

#return 語句從一個函數返回 即跳出函數。我們也可選從函數返回一個值
def maximum(x,y):
    if x > y:
        return x
    else:
        return y

print(maximum(5,3))


def someFunction():
    pass

print(someFunction())

#註意，沒有返回值的return語句等價於return None。None是Python中表示沒有任何東西的特殊類型。例如，如果一個變數的值為None，可以表示它沒有值。
#除非你提供你自己的return語句，每個函數都在結尾暗含有return None語句
#pass語句在Python中表示一個空的語句塊。

運行結果

DocStrings

Python有一個很奇妙的特性，稱為 文檔字元串 ，它通常被簡稱為 docstrings 。DocStrings是一個重要的工具，由於它幫助你的程式文檔更加簡單易懂，你應該儘量使用它。

在函數的第一個邏輯行的字元串是這個函數的 文檔字元串 。註意，DocStrings也適用於模塊和類，我們會在後面相應的章節學習它們。

文檔字元串的慣例是一個多行字元串，它的首行以大寫字母開始，句號結尾。第二行是空行，從第三行開始是詳細的描述。 強烈建議 你在你的函數中使用文檔字元串時遵循這個慣例。

你可以使用__doc__（註意雙下劃線）調用printMax函數的文檔字元串屬性（屬於函數的名稱）。請記住Python把 每一樣東西 都作為對象，包括這個函數。我們會在後面的類一章學習更多關於對象的知識。

如果你已經在Python中使用過help()，那麼你已經看到過DocStings的使用了！它所做的只是抓取函數的__doc__屬性，然後整潔地展示給你。你可以對上面這個函數嘗試一下——只是在你的程式中包括help(printMax)。記住按q退出help。

def printMax(x,y):
    '''Prints the maximum of two numbers.
    The two values must be integers.'''
    x=int(x) # convert to integers, if possible
    y=int(y)
    if x>y:
            print(x,'is maximum')
    else:
            print(y,'is maximum')
printMax(3,5)
print (printMax.__doc__)

運行結果