程式的可讀性最重要。
一般建議在函式體開始的部分新增注釋。
通過呼叫help(函式名.doc)可以檢視注釋。
#測試文件字串基本用法
defprintmax
(a,b)
:"""用於比較兩個數的大小,列印較大的值"""
if a > b :
print
(a,"是較小值"
)if aprint
(b,"較大值"
)printmax(11,
22)help
(printmax.__doc__)
》22 較大值
no python documentation found for
'用於比較兩個數的大小,列印較大的值'
.use help
() to get the interactive help utility.
use help
(str
)for
help on the str
class
.
Python 文件化字串
python有乙個很奇妙的特性,稱為 文件字串 它通常被簡稱為 docstrings docstrings是乙個重要的工具,由於它幫助你的程式文件更加簡單易懂,你應該盡量使用它。你甚至可以在程式執行的時候,從函式恢復文件字串!usr bin python filename func doc.py d...
文件字串
文件字串 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...