Приказивање документације функције у 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__)