Python-daky funksiýa dokumentasiýasyny çykarmak

Funksiýanyň bedeninde, amala aşyrylýan işiň mazmunyny beýan edýän setir ýazyp bolýar. Beýle setir funksiýanyň dokumentasiýasy hökmünde kabul edilýär. Ol bir sary dyrnak içine alynýar we funksiýanyň bedeniniň birinji setirinde ýerleşdirilýär. Ony okamak üçin ýörite help funksiýasy ulanylýar, onuň parametrine funksiýanyň ady berilýär.

Iki sany sanlary jemleýän funksiýamyz bardygyny düşüneli. Bu barada degişli maglumatly setir goýuldy:

pythondef getSum(num1, num2):
  'bu funksiýa iki sany jemleýär'
  return num1 + num2

help-i çagyryp, getSum-da näme düşündirilendigini bileliň:

pythonhelp(getSum)

Kod ýerine ýetirilenden soň, konsolda funksiýanyň ady we onuň dokumentasiýasy bilen setir peýda bolar:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  bu funksiýa iki sany jemleýär

help funksiýasy standart funksiýalaryň hem dokumentasiýasyny okap bilmek üçin ulanylýar. print funksiýasy barada maglumaty bileliň:

pythonhelp(print)

Funksiýadan diňe dokumentasiýa setirini çykarmak üçin, help-e funksiýanyň adyndan soň hyzmat amaly konstruksiýa .__doc__ berilmelidir:

pythonhelp(print.__doc__)