Python တွင် function များ၏ မှတ်တမ်းစာရွက်စာတမ်းများကို ဖော်ပြခြင်း

Function ၏ body အတွင်းတွင် ဆောင်ရွက်မည့်အလုပ်၏ အနှစ်သာရကို ဖော်ပြသော string တစ်ခုကို ရေးသားနိုင်သည်။ ထိုကဲ့သို့သော string ကို function ၏ မှတ်တမ်းစာရွက်စာတမ်းအဖြစ် သတ်မှတ်သည်။ ၎င်းကို single quotes များဖြင့် ထည့်သွင်းပြီး function body ၏ ပထမဆုံးလိုင်းတွင် ထားရှိသည်။ ယင်းကိုဖတ်ရှုရန် သီးသန့် function help ကို အသုံးပြုရပြီး ၎င်း၏ parameter တွင် function အမည်ကို ပေးပို့ရမည်။

နံပါတ်နှစ်ခုကို ပေါင်းခြင်းဖြင့် စုစုပေါင်းရှာပေးသော function တစ်ခုရှိသည်ဆိုပါစို့။ ထိုသို့သော အချက်အလက်ကို string တစ်ခုဖြင့် မှတ်သားထားသည်။

pythondef getSum(num1, num2):
  'this function sums two numbers'
  return num1 + num2

ယခု help ကိုခေါ်၍ getSum တွင် မည်သို့မှတ်သားထားသည်ကို ကြည့်ကြပါစို့။

pythonhelp(getSum)

ကုဒ်ကို run ပြီးနောက် console တွင် function အမည်နှင့် ၎င်း၏ မှတ်တမ်းစာရွက်စာတမ်းပါသော string ပေါ်လာမည်။

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  this function sums two numbers

Function help ကို အသုံးပြု၍ စံသတ်မှတ်ထားသော function များ၏ မှတ်တမ်းစာရွက်စာတမ်းကိုလည်း ဖတ်နိုင်သည်။ Function print အကြောင်း အချက်အလက်ကို ကြည့်ကြပါစို့။

pythonhelp(print)

Function အတွင်းမှ မှတ်တမ်းစာရွက်စာတမ်းစာသားကိုသာ ဖော်ပြရန်၊ help function ကို ခေါ်သောအခါ function အမည်နောက်တွင် ဝန်ဆောင်မှုပေးသော ဖွဲ့စည်းပုံ .__doc__ ကို ထည့်ပေးရမည်။

pythonhelp(print.__doc__)