您好,登錄后才能下訂單哦!
這篇文章主要介紹python之文檔字符串的用法,文中介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們一定要看完!
一、文檔字符串定義
文檔字符串(documentation string),通常也稱作:docstring。
在函數體的第一行,我們可以使用一對三個單引號(''')或者一對三個雙引號(""")來定義文檔字符串,文檔字符串通常第一行以大寫字母開頭,以句號(.)結束,第二行是空行,第三行開始是詳細描述,簡單的說就是給函數一個描述。
<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、函數/方法的def語句定義后到函數體之間,用于函數/方法說明;
3、類定義的class語句后到類體之間,用于類說明。
三、使用__doc__訪問文檔字符串
字符串在給函數描述的過程中,需要添加函數功能說明。這個說明可以使用.__doc__(注意前后都是雙_)屬性,將DocString特性print打印出來。
def inputxy(): '''''this is my first test doc''' print "hello the word" inputxy() print inputxy.__doc__# print pirntXY's doc
輸出內容:
hello the world this is my first test doc Process finished with exit code 0
以上是“python之文檔字符串的用法”這篇文章的所有內容,感謝各位的閱讀!希望分享的內容對大家有幫助,更多相關知識,歡迎關注億速云行業資訊頻道!
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。