新聞中心
上篇我們說到了能夠幫助程序員理解程序編寫者的代碼的方式是添加注釋,可是你知道嗎?想寫出易于理解的優(yōu)秀代碼,文檔字符串也是可以的。這時可能有人就有疑惑了,注釋起到解釋說明的作用大家通過字面意思可以明白,那文檔字符串是什么?怎么起解釋的作用呢?別急,下面,我們來介紹以下文檔字符串。

成都創(chuàng)新互聯(lián)堅持“要么做到,要么別承諾”的工作理念,服務領域包括:成都網(wǎng)站制作、成都網(wǎng)站設計、企業(yè)官網(wǎng)、英文網(wǎng)站、手機端網(wǎng)站、網(wǎng)站推廣等服務,滿足客戶于互聯(lián)網(wǎng)時代的衢州網(wǎng)站設計、移動媒體設計的需求,幫助企業(yè)找到有效的互聯(lián)網(wǎng)解決方案。努力成為您成熟可靠的網(wǎng)絡建設合作伙伴!
一、文檔字符串定義
文檔字符串(documentation string),通常也稱作:docstring。
在函數(shù)體的第一行,我們可以使用一對三個單引號(''')或者一對三個雙引號(""")來定義文檔字符串,文檔字符串通常第一行以大寫字母開頭,以句號(.)結束,第二行是空行,第三行開始是詳細描述,簡單的說就是給函數(shù)一個描述。
def add(a,b): """this a function to additon""" #文檔字符串 sum = a+b return sum
二、文檔字符串的用法
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
以上向大家介紹了文檔字符串的定義、函數(shù)描述、用法和使用__doc__訪問文檔字符串的方法,小伙伴們應該對文檔字符串有一定的了解了吧。python入門并不難,關鍵是要把基礎打?qū)?,加油哦~更多python學習推薦:python學習網(wǎng)python基礎。
網(wǎng)站標題:創(chuàng)新互聯(lián)Python教程:python入門:文檔字符串
URL地址:http://www.dlmjj.cn/article/dpdcsij.html


咨詢
建站咨詢
