這篇文章主要介紹python之文檔字符串的用法，文中介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們一定要看完！

讓客戶滿意是我們工作的目標(biāo)，不斷超越客戶的期望值來自于我們對這個(gè)行業(yè)的熱愛。我們立志把好的技術(shù)通過有效、簡單的方式提供給客戶，將通過不懈努力成為客戶在信息化領(lǐng)域值得信任、有價(jià)值的長期合作伙伴，公司提供的服務(wù)項(xiàng)目有：國際域名空間、虛擬主機(jī)、營銷軟件、網(wǎng)站建設(shè)、平羅網(wǎng)站維護(hù)、網(wǎng)站推廣。

一、文檔字符串定義

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

def add(a,b):

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

    sum = a+b

    return sum

 

二、文檔字符串的用法

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

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

字符串在給函數(shù)描述的過程中，需要添加函數(shù)功能說明。這個(gè)說明可以使用.__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)知識(shí)，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道！

本文標(biāo)題：python之文檔字符串的用法-創(chuàng)新互聯(lián)
本文URL：http://weahome.cn/article/ddspsd.html