python打印文檔字符串

def printMax(x,y):
    '''打印兩個數中的最大值。
    連個值必須是整數(徐陽)。'''
    x =int(x)  #如果有可能,轉爲整數
    y=int(y)

    if x>y:
        print(x,'最大')
    else:
        print(y,'最大')
printMax(3,5)
print(printMax.__doc__)



在>>>中輸入 print(printMax.__doc__)  得到的也是 

   '''打印兩個數中的最大值。
    連個值必須是整數(徐陽)。'''

  我們在使用def 關鍵字定義一個函數時,其後必須跟有函數名和包括形式參數的圓括號。函數體的下一行開始,必須是縮進的。函數體的第一行可以是字符串,這個字符串就是文檔字符串(documentation string),通常也稱作:docstring。


文檔字符串的定義:

         在函數體的第一行,我們可以使用一對三個單引號(''')或者一對三個雙引號(""")來定義文檔字符串,文檔字符串通常第一行以大寫字母開頭,以句號(.)結束,第二行是空行,第三行開始是詳細描述。強烈建議,爲你重要的寒素寫文檔字符串都遵循此慣例。


文檔字符串的作用:

      文檔字符串是我們使用Python過程中一個很重要的工具,他對程序文檔很有幫助,使程序很容易理解。甚至當程序運行的時候,我們可以從一個函數中返回文檔字符串。把函數當做一個對象來看,這更有助於我們的理解,就相當於獲取一個對象的屬性(__doc__).

     有些文檔字符串工具可以在線處理或打印文檔,或讓用戶交互的瀏覽代碼;在代碼中加入文檔字符串是一個好的作法,應該養成這個習慣。

     如果你在Python中已經使用過help(),那麼你已經看到如何使用文檔字符串了!它所做的僅僅是獲取函數的 __doc__ 屬性,並以一個整潔的方式顯示給你。你可以在上面的函數——在你的程序中僅包括help(printMax)嘗試一下。記得按下q鍵,退出help.

    自動化工具可以從你的程序中以這種方式檢索文檔。因此,我強烈建議,爲你寫的任何重要函數使用文檔字符串。來自Python的自動化工具pydoc命令使用文檔字符串的工作原理類似於help()。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章