Funkcijas dokumentācijas izvade Python

Funkcijas pamatvarā var ierakstīt virkni, kas apraksta veicamā darba būtību. Šādu virkni parasti uzskata par funkcijas dokumentāciju. To ieliek vienpēdiņās un ievieto funkcijas pamatvara pirmajā rindā. Lai to nolasītu, jāizmanto speciāla funkcija help, kuras parametrā tiek padots funkcijas nosaukums.

Pieņemsim, ka mums ir funkcija, kas saskaita divus skaitļus. Par to ir atstāta virkne ar atbilstošu informāciju:

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

Izsaucam help un uzzināsim, kas ir komentēts getSum:

pythonhelp(getSum)

Pēc koda izpildes konsolē parādīsies virkne ar funkcijas nosaukumu un tās dokumentāciju:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  this function sums two numbers

Izmantojot funkciju help, var nolasīt dokumentāciju arī standarta funkcijām. Uzzināsim informāciju par funkciju print:

pythonhelp(print)

Lai izvadītu tikai dokumentācijas virkni no funkcijas, funkcijai help pēc funkcijas nosaukuma jāpadod servisa konstrukcija .__doc__:

pythonhelp(print.__doc__)