Python හි ශ්‍රිතයක් සඳහා ප්‍රලේඛනය ප්‍රතිදානය කිරීම

ශ්‍රිතයක ශරීරය තුළ, සිදු කරන කාර්යයේ ස්වරූපය විස්තර කරන නූලක් ඇතුළත් කළ හැකිය. එවැනි නූලක් සාමාන්‍යයෙන් ශ්‍රිතයේ ප්‍රලේඛනය ලෙස සැලකේ. එය තනි උපුටා දැක්වීම් වලින් ගෙන ඇති අතර ශ්‍රිතයේ ශරීරයේ පළමු පේළියේ තබා ඇත. එය කියවීමට, ඔබට විශේෂ help ශ්‍රිතය භාවිතා කළ යුතු අතර, එහි පරාමිතියට ශ්‍රිතයේ නම සම්ප්‍රේෂණය කෙරේ.

අපට අංක දෙකක් එකතු කරන ශ්‍රිතයක් ඇතැයි සිතන්න. මේ සම්බන්ධයෙන් අදාළ තොරතුරු සහිත නූලක් ඉතිරි කර ඇත:

pythondef getSum(num1, num2):
  'මෙම ශ්‍රිතය අංක දෙකක් එකතු කරයි'
  return num1 + num2

අපි help ආමන්ත්‍රණය කර getSum හි අදහස් දැක්වීම් කර ඇත්තේ කුමක්දැයි සොයා බලමු:

pythonhelp(getSum)

කේතය ක්‍රියාත්මක කිරීමෙන් පසු, ශ්‍රිතයේ නම සහ එහි ප්‍රලේඛනය සහිත නූලක් කොන්සෝලයේ දිස්වනු ඇත:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  මෙම ශ්‍රිතය අංක දෙකක් එකතු කරයි

help ශ්‍රිතය භාවිතයෙන්, සම්මත ශ්‍රිතවල ප්‍රලේඛනය ද කියවිය හැකිය. අපි print ශ්‍රිතය පිළිබඳ තොරතුරු සොයා ගනිමු:

pythonhelp(print)

ශ්‍රිතයකින් ප්‍රලේඛන නූල පමණක් ප්‍රතිදානය කිරීම සඳහා, help හි ශ්‍රිත නමට පසුව සේවා සැකසුම .__doc__ සම්ප්‍රේෂණය කළ යුතුය:

pythonhelp(print.__doc__)