你所看到的有一個文檔字符串,或簡稱爲docstring。
docstring是一個字符串,應該記錄它連接到的東西。在你的情況下,它被附加到一個函數,因此應該記錄該函數。你也可以有類和模塊的文檔。
通過簡單地將一個字符串作爲函數(或類或模塊)中的第一個東西來創建文檔字符串。然後,解釋器將使用它作爲一個文檔字符串,使其在特殊的__doc__
屬性可供選擇:
>>> def printme(str):
"This prints a passed string into this function"
print str
>>> printme.__doc__
'This prints a passed string into this function'
文檔字符串也使用了help()
功能:
>>> help(printme)
Help on function printme in module __main__:
printme(str)
This prints a passed string into this function
的文檔字符串的慣例,使它清楚地表明它們應該是實際的文檔,而不是錯誤地放置「適當的」字符串,就是使用三重引號。三重引號用於創建多行字符串其中除了允許文檔字符串是多線太:
def printme (str):
'''
Print the string passed in the `str` argument to the
standard output. This is essentially just a wrapper
around Python’s built-in `print`.
'''
print(str)
各種文檔字符串約定在PEP 257也有描述。
因爲字符串不是'打印'。 –
我明白了,但如果在終端輸入「hello」,在終端中正常使用python時,會返回「hello」?這是一個具體的區別適用? – user2713650
這是因爲IDLE具有與實際運行腳本不同的行爲。 –