5.5 檔案字串
開發者在撰寫函式或模塊時不光要自己能看懂，在和他人合作共同開發或者被他人呼叫時也需要他人也能看懂，這個時候就可以為自己撰寫的函式、模塊或者類添加相應的檔案字串(docstring)進行說明了，
一般的，如果想要在模塊中添加模塊檔案字串，則需要在模塊的最上方用3個雙引號引住內容，這部分內容則自動會被識別為模塊的檔案字串，
注意：模塊檔案字串上方可以有注釋內容，但是不能有任何Python陳述句，否則不會被識別成模塊檔案字串，
同理，如果想要在函式中添加檔案字串，也是需要在定義函式后馬上跟上函式檔案字串內容，否則也不會被識別成函式檔案字串，在以后類的定義時也是同理，
放在函式開頭的字串稱為函式檔案字串(docstring)，將作為函式的一部分存盤起來，下面的代碼演示了如何給函式添加檔案字串：
def square(x):
'Calculates the square of the number x.'
return x * x
可以像下面這樣訪問檔案字串：
>>> square.doc
'Calculates the square of the number x.'
注意__doc__是函式的一個屬性，屬性名中的雙下劃線表示這是一個特殊的屬性，
示例：為函式添加檔案字串并對引數進行說明
def frb_num_to_str(p_num, p_is_makeup=False, p_int_num=6):
"""
將一個int型別或者float型別轉變成str型別，若p_is_makeup為True，則需要補齊為p_int_num位，
@param p_num: 輸入的引數，一個int型別或者float型別資料
@param p_is_makeup: 是否要補齊到指定位數
@param p_int_num: 補齊的指定位數
@return:
"""
result = p_num
if isinstance(p_num, int):
result = str(p_num)
elif isinstance(p_num, float):
result = str(p_num)[:str(p_num).find('.')]
elif isinstance(p_num, str):
result = p_num
# 判斷傳入的num的型別
if p_is_makeup and len(result) < p_int_num:
result = '0' * (p_int_num - len(result)) + result
return result
提示：
為函式、類、模塊自動添加檔案字串參照Pycharm軟體設定，
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/541650.html
標籤：其他
上一篇：Python中的例外處理總結
下一篇：JDBC