Python有一個(gè)很奇妙的特性,稱(chēng)為 文檔字符串 ,它通常被簡(jiǎn)稱(chēng)為 docstrings 。DocStrings是一個(gè)重要的工具,由于它幫助你的程序文檔更加簡(jiǎn)單易懂,你應(yīng)該盡量使用它。你甚至可以在程序運(yùn)行的時(shí)候,從函數(shù)恢復(fù)文檔字符串!

#!/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(
35)
print printMax.__doc__ 
輸出
$ python func_doc.py
5 is maximum
Prints the maximum of two numbers.
        The two values must be integers.

它如何工作
在函數(shù)的第一個(gè)邏輯行的字符串是這個(gè)函數(shù)的 文檔字符串 。注意,DocStrings也適用于模塊和
類(lèi),我們會(huì)在后面相應(yīng)的章節(jié)學(xué)習(xí)它們。
文檔字符串的慣例是一個(gè)多行字符串,它的首行以大寫(xiě)字母開(kāi)始,句號(hào)結(jié)尾。第二行是空行,
從第三行開(kāi)始是詳細(xì)的描述。
強(qiáng)烈建議 你在你的函數(shù)中使用文檔字符串時(shí)遵循這個(gè)慣例。
你可以使用__doc__(注意雙下劃線)調(diào)用printMax函數(shù)的文檔字符串屬性(屬于函數(shù)的名
稱(chēng))。請(qǐng)記住Python把 每一樣?xùn)|西 都作為對(duì)象,包括這個(gè)函數(shù)。