Python學習筆記010 函式文件字串

函式文件字串documentation string （docstring）是在函式開頭，用來解釋其介面的字串。簡而言之：幫助文件

包含函式的基礎資訊

包含函式的功能簡介

包含每個形參的型別，使用等資訊

是介面設計的重要部分。

注：乙個良好的介面不能簡單、清晰的表述該函式，則說明該函式還有優化改進的空間

函式文件的使用

必須在函式的首行，經過驗證前面有注釋性說明是可以的，不過最好函式文件出現在首行

使用三引號註解的多行字串（當然，也可以是一行），因三引號可以實現多行註解（展示）(''' ''') 或(""" """)

函式文件的第一行一般概述函式的主要功能，第二行空，第三行詳細描述。

檢視方式

在互動模式下可以使用ｈｅｌｐ檢視函式，幫助文件，該介面會跳到幫助介面，需要輸入q退出介面

使用__doc__屬性檢視，該方法的幫助文件文字直接顯示在互動介面上。

舉例說明

def

test():
'''函式名：test
功能：測試
引數：無
返回值：無
'''print("
函式輸出成功")
test()

>>> import

day10
>>> help(day10.test)

按q鍵退出

同樣在互動模式下出入

>>> import

day10
>>> print(day10.test.__doc__
) 函式名：test
功能：測試
引數：無
返回值：無
>>>

在其下直接顯示幫助文件。

python筆記 010 函式（下）

使用任意數量的關鍵字實參 def build profile first,last,user info 建立乙個字典，其中包含我們知道的有關使用者的一切 profile profile first name first profile last name last for key,value in ...

Python學習筆記 函式

1.基本呼叫 python 中的函式使用關鍵字 def 來建立乙個函式，正如其他語言中的函式一樣，有函式名，引數，以及返回值。函式的引數不用指定型別，return 可以在任何地方出現，表示函式結束，如果沒有返回內容則預設返回值為none。乙個簡單的無引數，無返回值的hello world def h...

python學習筆記 函式

def fun object,param1,param2 none print type object tuple,呼叫時預設的所有實參全部轉化為tuple傳遞給object fun 1,2,3,4,5,6,7,param1 8 指定param1的呼叫實參，param2引數呼叫預設值函式內可訪問全域...