介紹返回值 | 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學習站