Python簡明教程

標籤：ack   擷取   空行   自動化   教程   docstring   round   應該   功能   

DocStrings

該文檔字串所約定的是一串多行字串，其中第一行以某一大寫字母開始，以句號結束。第二行為空白行，後跟的第三行開始是任何詳細的解釋說明。
在此強烈建議你在有關你所有非凡功能的文檔字串中都遵循這一約定。我們可以通過使用函數的 __doc__（注意其中的雙下劃綫）屬性（屬於函數的名稱）來擷取函數 print_max 的文檔字串屬性。
只消記住 Python 將所有東西都視為一個對象，這其中自然包括函數。我們將在後面的類（Class）章節討論有關對象的更多細節。+如果你曾使用過 Python 的 help() 函數，那麼你應該已經瞭解了文檔字串的用途了。它所做的便是擷取函數的 __doc__ 屬性並以一種整潔的方式將其呈現給你
。你可以在上方的函數中嘗試一下——只需在程式中包含 help(print_max) 就行了。要記住你可以通過按下 q 鍵來退出 help。自動化工具可以以這種方式檢索你的程式中的文檔。因此，我強烈推薦你為你編寫的所有不平凡的函數配以文檔字串。
你的 Python 發行版中附帶的 pydoc 命令與 help() 使用文檔字串的方式類似。

 

Python簡明教程