Python 文件化字串

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__

$ python func_doc.py

5 is maximum
prints the maximum of two numbers.
the two values must be integers.

在函式的第乙個邏輯行的字串是這個函式的 文件字串 。

文件字串的慣例是乙個多行字串，它的首行以大寫字母開始，句號結尾。第二行是空行，從第三行開始是詳細的描述。 強烈建議 你在你的函式中使用文件字串時遵循這個慣例。

你可以使用__doc__（注意雙下劃線）呼叫printmax函式的文件字串屬性（屬於函式的名稱）。請記住python把 每一樣東西 都作為物件，包括這個函式。

如果你已經在python中使用過help()，那麼你已經看到過docstings的使用了！它所做的只是抓取函式的__doc__屬性，然後整潔地展示給你。你可以對上面這個函式嘗試一下——只是在你的程式中包括help(printmax)。記住按q退出help。

自動化工具也可以以同樣的方式從你的程式中提取文件。因此，我 強烈建議 你對你所寫的任何正式函式編寫文件字串。隨你的python發行版附帶的pydoc命令，與help()類似地使用docstrings。

python之文件字串

程式的可讀性最重要。一般建議在函式體開始的部分新增注釋。通過呼叫help 函式名.doc 可以檢視注釋。測試文件字串基本用法 defprintmax a,b 用於比較兩個數的大小，列印較大的值 if a b print a,是較小值 if aprint b,較大值 printmax 11,22 he...

文件字串

文件字串 python中我們可以定義很多函式，函式越多，對於開發人員來說，就會亂。有兩種方法解決這個問題，第一種是在開發的時候為每個函式寫乙個文件進行說明，第二種是python種所特有的特性，就是在每個函式開頭的地方，加上一行說明性文字，這行說明性文字稱為文件字串。文件字串 def d i,j 這個...

文件字串 doc

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 m...