為函式提供說明文件

2021-09-24 21:53:49 字數 912 閱讀 4399

使用 python 內建的 help() 函式檢視其他函式的幫助文件,我們也經常通過 help() 函式檢視指定函式的幫助資訊,這對於 python 開發者來說非常重要。

我們還可以為函式編寫說明文件,只要把一段字串放在函式宣告之後、函式體之前,這段字串將被作為函式的部分,這個文件就是函式的說明文件。

程式既可通過 help() 函式檢視函式的說明文件,也可通過函式的doc屬性訪問函式的說明文件。下面程式示範了為函式編寫說明文件:

def my_max(x, y) :

'''獲取兩個數值之間較大數的函式。

my_max(x, y)

返回x、y兩個引數之間較大的那個

'''# 定義乙個變數z,該變數等於x、y中較大的值

z = x if x > y else y

# 返回變數z的值

return z

# 使用help()函式檢視my_max的幫助文件

help(my_max)

print(my_max.__doc__)

上面程式使用多行字串的語法為 my_max() 函式編寫了說明文件,接下來程式既可通過 help() 函式檢視該函式的說明文件,也可通過doc屬性訪問該函式的說明文件。

執行上面**,可以看到如下執行結果:

help on function my_max in module __main__:

my_max(x, y)

獲取兩個數值之間較大數的函式。

my_max(x, y)

返回x、y兩個引數之間較大的那個

獲取兩個數值之間較大數的函式。

my_max(x, y)

返回x、y兩個引數之間較大的那個

hive hql文件 HIVE說明文件

sql 查詢功能,可以將sql 語句轉換為 mapreduce 任務進行執行,通過自己的 sql去查詢分析需要的內容,這套 sql簡稱 hive sql,使不熟悉 mapreduce 的使用者很 方便的利用 sql語言查詢,彙總,分析資料。hive 適用性 它與關係型資料庫的 sql略有不同,但支援...

Mantis安裝說明文件

在錯誤追蹤系統中,mantis絕對是個輕量級的工具,無論安裝還是配置或使用,正如它自己的目標中所宣稱的。但是,對乙個中小型的專案來言,功能夠用。mantis是乙個基於php mysql web的開源的錯誤追蹤系統,以下安裝教程假設系統已經安裝好了apache php mysql的執行系統,如何安裝這...

Vue 基礎說明文件

vue是乙個mvvm框架,model view viewmodel 例項出的物件 el 檢視模型,頁面節點 data 所使用的變數,或者初始值 裡面通常放屬性 methods dom渲染完執行,通常是放view中需要響應的函式 解析資料 變數,函式,表示式 一 指令 1,v html v text ...