Output della documentazione delle funzioni in Python

Nel corpo di una funzione è possibile scrivere una stringa, che descrive l'essenza del lavoro svolto. Tale stringa è considerata la documentazione della funzione. È racchiusa tra virgolette singole e posizionata nella prima riga del corpo della funzione. Per leggerla, è necessario utilizzare una funzione speciale help, nel cui parametro viene passato il nome della funzione.

Supponiamo di avere una funzione che somma due numeri. Questo è indicato da una stringa con le relative informazioni:

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

Chiamiamo help e scopriamo cosa è commentato in getSum:

pythonhelp(getSum)

Dopo l'esecuzione del codice, nella console apparirà una stringa con il nome della funzione e la sua documentazione:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  this function sums two numbers

Con la funzione help puoi leggere la documentazione anche delle funzioni standard. Scopriamo le informazioni sulla funzione print:

pythonhelp(print)

Per visualizzare solo la stringa con la documentazione della funzione, è necessario passare a help dopo il nome della funzione la costruzione servizio .__doc__:

pythonhelp(print.__doc__)