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__)