我有一個通用的文檔字符串格式,我在製作函數時試圖遵循這些格式。我給出了這個函數做了什麼總結,然後簡要說明了它輸入什麼類以及輸出什麼類。爲某些python函數傳輸文檔字符串
def cuberoot4u(number):
"""Returns the cube root of number.
cuberoot4u(float) -> float
"""
return pow(number, 1/3)
因此,在這種情況下,cuberoot4u爲輸入獲取一個浮點數並返回一個用於輸出的浮點數。
如何以文檔形式最好地向用戶傳達函數需要什麼類輸入,如果它需要.txt文件作爲輸入並輸出字符串中的內容?
def getText(filename):
"""Reads the file filename and returns the content.
getText(?????) -> str
"""
fd = open(filename)
text = fd.read()
fd.close()
return text
難道是最好說getText(filename.txt) -> str
或者是有一個特定的類名是很像的字符串是「STR」和一個整數是「廉政」?
另外,關於其輸出不象本實施例中清楚地定義的函數什麼:
def commandmenu():
"""Begin some random menu which does stuff.
commandmenu() -> ??????
"""
while 1:
someuserinput = input("Enter a command: ")
if someuserinput == 'this':
pass
elif someuserinput == 'that':
pass
else:
print('u suck')
return None
因此,在這種情況下,存在進入的功能沒有初始輸出,因爲它導致一個來自用戶的輸入在它做某事之前。什麼最適合?????如果這樣的功能變得越來越細緻,並且可能導致多種不同的輸出,這取決於對用戶的提示等等。