介紹傳回值 | Python從入門到精通：高階篇之七
文檔字元串
在了解文檔字元串之前，我們需要先去知道help()。
help()是Python中的内置函數，通過help()函數可以查詢python中的函數的用法。
文法：help(函數對象) 現在來擷取print()函數的使用說明。
help(print) 執行結果：
我們可以得到print()函數的具體使用說明。包括列印結果還有一些檔案說明等。
接下來我們自定義一個函數。
def fn(a,b,c):
return 10
help(fn) 
此時可以發現，顯示出來的資訊不是很完全，是因為我們沒有給函數去說明，是以沒有資訊輸出，但是我們在開發過程中，有解釋意義顯然是更好一點。此時就需要解釋文檔字元串了。
文檔字元串（doc str）
在定義函數時，可以在函數内部編寫文檔字元串，文檔字元串就是函數的說明。當我們編寫了文檔字元串時，就可以通過help()函數來檢視函數的說明。文檔字元串非常簡單，其實直接在函數的第一行寫一個字元串就是文檔字元串。
我們一般使用一對
'''
來解釋說明。
def fn(a,b,c):
'''
這是一個文檔字元串的示例
函數的作用：。。。。。
函數的參數：
a，作用，類型，預設值。。。。
b，作用，類型，預設值。。。。
c，作用，類型，預設值。。。。
'''
return 10
help(fn) 這個文檔字元串不是強制性要求，但是我們應該養成一個良好的習慣，幫助自己了解的同時也可以幫助别人了解。
複雜示例：
def fn(a:int,b:bool,c:str):
'''
這是一個文檔字元串的示例
函數的作用：。。。。。
函數的參數：
a，作用，類型，預設值。。。。
b，作用，類型，預設值。。。。
c，作用，類型，預設值。。。。
'''
return 10
help(fn) 此時假設c有預設值，則可以直接聲明：
def fn(a:int,b:bool,c:str='hello') 我們針對上述代碼再次修改，表達傳回值類型。
def fn(a:int,b:bool,c:str='hello') -> int: 此時表示的是傳回值是int類型。
對于文檔字元串的編寫，我們要求一般是用英文進行編寫。也根據實際開發情況進行調整。
配套視訊課程，點選這裡檢視
擷取更多資源請訂閱
Python學習站