新聞中心
這里有您想知道的互聯(lián)網(wǎng)營銷解決方案
Python基礎(chǔ)講解:函數(shù)文檔
python函數(shù)文檔可以大大提高開發(fā)的效率,讓別人一看你這個函數(shù),就馬上知道這個函數(shù)的功能,以及需要什么類型的參數(shù),下面為大家詳細(xì)講解一下python函數(shù)文檔實(shí)用方法。

專注于為中小企業(yè)提供成都網(wǎng)站建設(shè)、做網(wǎng)站服務(wù),電腦端+手機(jī)端+微信端的三站合一,更高效的管理,為中小企業(yè)陽東免費(fèi)做網(wǎng)站提供優(yōu)質(zhì)的服務(wù)。我們立足成都,凝聚了一批互聯(lián)網(wǎng)行業(yè)人才,有力地推動了上千余家企業(yè)的穩(wěn)健成長,幫助中小企業(yè)通過網(wǎng)站建設(shè)實(shí)現(xiàn)規(guī)模擴(kuò)充和轉(zhuǎn)變。
函數(shù)文檔及作用
作用:
-
-
函數(shù)也需要添加注釋, 方便函數(shù)功能、參數(shù)以及返回值的含義能夠被調(diào)用者知悉.
-
能夠在調(diào)用時快捷查看函數(shù)相關(guān)信息 和單行注釋相比:
普通的單行、多行注釋, 需要查看函數(shù)定義時才能看到
快捷鍵
通過 ctrl + q 快捷鍵可以查看函數(shù)信息, 也可以通過 help() 函數(shù)來查看函數(shù)信息
工具:
DocString 是一個重要的工具, 由于它幫助你的程序文檔更加簡單易懂
-
案例:
-
# 單行函數(shù)文檔字符串?
def my_function(param):
"""函數(shù)做了什么事, 返回什么結(jié)果."""
return param + 10
# 多行函數(shù)文檔字符串
def my_add(num1, num2):
"""計(jì)算兩個整數(shù)的和. :param int num1: 加法運(yùn)算的左操作數(shù) :param int num2: 加法運(yùn)算的右操作數(shù) :return 返回兩個操作數(shù)相加的結(jié)果 """
result = num1 + num2
return result
當(dāng)前名稱:Python基礎(chǔ)講解:函數(shù)文檔
本文URL:http://www.fisionsoft.com.cn/article/dpcipgo.html


咨詢
建站咨詢
