溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務(wù)條款》

python之文檔字符串的用法

發(fā)布時間:2020-11-30 13:51:18 來源:億速云 閱讀:320 作者:小新 欄目:編程語言

這篇文章主要介紹python之文檔字符串的用法,文中介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們一定要看完!

一、文檔字符串定義

文檔字符串(documentation string),通常也稱作:docstring。
在函數(shù)體的第一行,我們可以使用一對三個單引號(''')或者一對三個雙引號(""")來定義文檔字符串,文檔字符串通常第一行以大寫字母開頭,以句號(.)結(jié)束,第二行是空行,第三行開始是詳細描述,簡單的說就是給函數(shù)一個描述。

<span style="font-size:24px;">def add(a,b):

    """this a function to additon"""   #文檔字符串

    sum = a+b

    return sum</span><span style="font-size:18px; ">

 </span>

二、文檔字符串的用法

1、模塊開頭,作為整個模塊的文檔說明;
2、函數(shù)/方法的def語句定義后到函數(shù)體之間,用于函數(shù)/方法說明;
3、類定義的class語句后到類體之間,用于類說明。

三、使用__doc__訪問文檔字符串

字符串在給函數(shù)描述的過程中,需要添加函數(shù)功能說明。這個說明可以使用.__doc__(注意前后都是雙_)屬性,將DocString特性print打印出來。

def inputxy():  
    '''''this is my first test doc'''
    print "hello the word"
inputxy()  
print inputxy.__doc__# print pirntXY's doc

輸出內(nèi)容:

hello the world  
this is my first test doc  
  
Process finished with exit code 0

以上是“python之文檔字符串的用法”這篇文章的所有內(nèi)容,感謝各位的閱讀!希望分享的內(nèi)容對大家有幫助,更多相關(guān)知識,歡迎關(guān)注億速云行業(yè)資訊頻道!

向AI問一下細節(jié)

免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI