# DocStrings Python有一個很奇妙的特性，稱為 文檔字符串 ，它通常被簡稱為 docstrings 。DocStrings是一個重要的工具，由于它幫助你的程序文檔更加簡單易懂，你應該盡量使用它。你甚至可以在程序運行的時候，從函數恢復文檔字符串！ ``` #!/usr/bin/python # Filename: func_doc.py def printMax(x, y): ????'''Prints the maximum of two numbers. ????The two values must be integers.''' ????x = int(x) # convert to integers, if possible ????y = int(y) ????if x > y: ????????print x, 'is maximum' ????else: ????????print y, 'is maximum' printMax(3, 5) print printMax.__doc__ ``` （源文件：[code/func_doc.py](code/func_doc.py)） ## 輸出 ``` $ python func_doc.py 5 is maximum Prints the maximum of two numbers. ????????The two values must be integers. ``` ## 它如何工作 在函數的第一個邏輯行的字符串是這個函數的 文檔字符串 。注意，DocStrings也適用于[模塊](ch08.html)和[類](ch11.html)，我們會在后面相應的章節學習它們。 文檔字符串的慣例是一個多行字符串，它的首行以大寫字母開始，句號結尾。第二行是空行，從第三行開始是詳細的描述。 強烈建議 你在你的函數中使用文檔字符串時遵循這個慣例。 你可以使用`__doc__`（注意雙下劃線）調用`printMax`函數的文檔字符串屬性（屬于函數的名稱）。請記住Python把 每一樣東西 都作為對象，包括這個函數。我們會在后面的[類](ch11.html)一章學習更多關于對象的知識。 如果你已經在Python中使用過`help()`，那么你已經看到過DocStings的使用了！它所做的只是抓取函數的`__doc__`屬性，然后整潔地展示給你。你可以對上面這個函數嘗試一下——只是在你的程序中包括`help(printMax)`。記住按**q**退出`help`。 自動化工具也可以以同樣的方式從你的程序中提取文檔。因此，我 強烈建議 你對你所寫的任何正式函數編寫文檔字符串。隨你的Python發行版附帶的**pydoc**命令，與`help()`類似地使用DocStrings。