python中的文件字串 docString

2021-09-06 06:46:16 字數 1631 閱讀 5572

python中的文件字串(docstring) - 泥土 -

posted on

2009-02-19 15:27

0)  

編輯收藏

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中的文件字串 docString

泥土 閱讀 609 編輯收藏 所屬分類 python python有乙個很奇妙的特性,稱為 文件字串 它通常被簡稱為 docstrings docstrings是乙個重要的工具,由於它幫助你的程式文件更加簡單易懂,你應該盡量使用它。你甚至可以在程式執行的時候,從函式恢復文件字串!usr bin py...

python中的文件字串 docString

注 本文 python有乙個很奇妙的特性,稱為 文件字串 它通常被簡稱為 docstrings docstrings是乙個重要的工具,由於它幫助你的程式文件更加簡單易懂,你應該盡量使用它。你甚至可以在程式執行的時候,從函式恢復文件字串!usr bin python filename func doc...

Python 文件化字串

python有乙個很奇妙的特性,稱為 文件字串 它通常被簡稱為 docstrings docstrings是乙個重要的工具,由於它幫助你的程式文件更加簡單易懂,你應該盡量使用它。你甚至可以在程式執行的時候,從函式恢復文件字串!usr bin python filename func doc.py d...