上篇我們說(shuō)到了能夠幫助程序員理解程序編寫(xiě)者的代碼的方式是添加注釋?zhuān)墒悄阒绬?？想?xiě)出易于理解的優(yōu)秀代碼，文檔字符串也是可以的。這時(shí)可能有人就有疑惑了，注釋起到解釋說(shuō)明的作用大家通過(guò)字面意思可以明白，那文檔字符串是什么？怎么起解釋的作用呢？別急，下面，我們來(lái)介紹以下文檔字符串。

成都創(chuàng)新互聯(lián)堅(jiān)持“要么做到，要么別承諾”的工作理念，服務(wù)領(lǐng)域包括：成都網(wǎng)站制作、成都網(wǎng)站設(shè)計(jì)、企業(yè)官網(wǎng)、英文網(wǎng)站、手機(jī)端網(wǎng)站、網(wǎng)站推廣等服務(wù)，滿(mǎn)足客戶(hù)于互聯(lián)網(wǎng)時(shí)代的衢州網(wǎng)站設(shè)計(jì)、移動(dòng)媒體設(shè)計(jì)的需求，幫助企業(yè)找到有效的互聯(lián)網(wǎng)解決方案。努力成為您成熟可靠的網(wǎng)絡(luò)建設(shè)合作伙伴！

一、文檔字符串定義

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

def add(a,b):

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

    sum = a+b

    return sum

 

二、文檔字符串的用法

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

三、使用__doc__訪(fǎng)問(wèn)文檔字符串

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

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

以上向大家介紹了文檔字符串的定義、函數(shù)描述、用法和使用__doc__訪(fǎng)問(wèn)文檔字符串的方法，小伙伴們應(yīng)該對(duì)文檔字符串有一定的了解了吧。python入門(mén)并不難，關(guān)鍵是要把基礎(chǔ)打?qū)?，加油哦~更多python學(xué)習(xí)推薦：python學(xué)習(xí)網(wǎng)python基礎(chǔ)。

分享標(biāo)題：創(chuàng)新互聯(lián)Python教程：python入門(mén)：文檔字符串
網(wǎng)頁(yè)鏈接：http://uogjgqi.cn/article/dpdcsij.html