Python функциясынын документтер чыгаруусу

Функциянын денесинде аткарылуучу иштин мүнөзүн сүрөттөгөн сап жазылышы мүмкүн. Мындай сап функциянын документтер сабы деп эсептелет. Ал бир өтүк тырмакчага алынып, функциянын денесинин биринчи сабында жайгаштырылат. Аны окуш үчүн, атайын help функциясын колдонуу керек, анын параметрине функциянын аты берилет.

Бизде эки санды кошкон функция бар деп коёлу. Бул жөнүндө тиешелүү маалымат сабы калтырылган:

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

Келгиле, help чакырып, getSum ичинде эмне комментарийленгенин билип алалы:

pythonhelp(getSum)

Код аткарылгандан кийин консольдо функциянын аты жана анын документтер сабы менен сап пайда болот:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  this function sums two numbers

help функциясынын жардамы менен стандарттуу функциялардын документтерин да окуса болот. Келгиле, print функциясы жөнүндө маалыматты билип алалы:

pythonhelp(print)

Функциядан документтер сабын гана чыгаруу үчүн, help функциясына функциянын атынан кийин .__doc__ кызматтык конструкциясын берүү керек:

pythonhelp(print.__doc__)