創(chuàng)新互聯(lián)www.cdcxhl.cn八線動態(tài)BGP香港云服務(wù)器提供商，新人活動買多久送多久，劃算不套路！

創(chuàng)新互聯(lián)主要從事網(wǎng)站設(shè)計制作、成都網(wǎng)站制作、網(wǎng)頁設(shè)計、企業(yè)做網(wǎng)站、公司建網(wǎng)站等業(yè)務(wù)。立足成都服務(wù)灤南,10年網(wǎng)站建設(shè)經(jīng)驗,價格優(yōu)惠、服務(wù)專業(yè),歡迎來電咨詢建站服務(wù):13518219792

這篇文章給大家分享的是有關(guān)關(guān)閉python文檔字符串的方法的內(nèi)容。小編覺得挺實用的，因此分享給大家做個參考。一起跟隨小編過來看看吧。

Python有一個很奇妙的特性，稱為文檔字符串 ，它通常被簡稱為docstrings 。DocStrings是一個重要的工具，由于它幫助你的程序文檔更加簡單易懂，你應(yīng)該盡量使用它。你甚至可以在程序運(yùn)行的時候，從函數(shù)恢復(fù)文檔字符串！

使用docStrings

#!/usr/bin/python
# Filename: func_doc.py
def printMax(x, y):
    '''Prints the maximum of two numbers.
    The two values must be integers.'''
    x = int(x) # convert to integers, if possible
    y = int(y)
    
    if x > y:
        print x, 'is maximum'
    else:
        print y, 'is maximum'
printMax(3, 5)
print printMax.__doc__

輸出：

$ python func_doc.py
5 is maximum
Prints the maximum of two numbers.
    The two values must be integers.

它如何工作的

在函數(shù)的第一個邏輯行的字符串是這個函數(shù)的文檔字符串 。

文檔字符串的慣例是一個多行字符串，它的首行以大寫字母開始，句號結(jié)尾。第二行是空行，從第三行開始是詳細(xì)的描述。 強(qiáng)烈建議你在你的函數(shù)中使用文檔字符串時遵循這個慣例。

你可以使用__doc__（注意雙下劃線）調(diào)用printMax函數(shù)的文檔字符串屬性（屬于函數(shù)的名稱）。請記住Python把每一樣?xùn)|西都作為對象，包括這個函數(shù)。

如果你已經(jīng)在Python中使用過help()，那么你已經(jīng)看到過DocStings的使用了！它所做的只是抓取函數(shù)的__doc__屬性，然后整潔地展示給你。你可以對上面這個函數(shù)嘗試一下——只是在你的程序中包括help(printMax)。記住按q退出help。

自動化工具也可以以同樣的方式從你的程序中提取文檔。因此，我強(qiáng)烈建議你對你所寫的任何正式函數(shù)編寫文檔字符串。隨你的Python發(fā)行版附帶的pydoc命令，與help()類似地使用DocStrings。

感謝各位的閱讀！關(guān)于關(guān)閉python文檔字符串的方法就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，讓大家可以學(xué)到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！

分享標(biāo)題：關(guān)閉python文檔字符串的方法-創(chuàng)新互聯(lián)
網(wǎng)頁地址：http://weahome.cn/article/codjjj.html