Come creare un help online delle funzioni python

Quando definisco una nuova funzione in python posso aggiungere una stringa di documentazione sotto forma di commento nella prima riga della funzione.

def nomefunzione()
''' stringa di descrizione '''
...

A cosa serve?

Oltre a spiegare agli altri programmatori cosa fa la funzione, questa stringa viene mostrata come help online quando la digito sull'editor IDLE.

Nota. In questo modo, posso ricordarmi di cosa si tratta, senza andare a leggere la parte del codice sorgente in cui si trova la funzione.

    Un esempio pratico

    In questo script definisco una funzione che calcola il fattoriale tramite la ricorsione.

    Ha in input soltanto un parametro.

    1. def fattoriale(n):
    2. ''' digita il numero fattoriale '''
    3. if (n<2):
    4. return 1
    5. return n*fattoriale(n-1)
    6. y=fattoriale(3)
    7. print(y)

    Nella prima riga indentata della funzione digito la stringa di descrizione sotto forma di commento.

    Quando digito il nome della funzione sull'editor, dopo la parentesi tonda di apertura viene visualizzato l'elenco degli argomenti e la descrizione.

    la descrizione della funzione

    E' una funzionalità molto utile per chi programma.

    Nota. L'help online personalizzato delle funzioni è particolarmente utile se il programma lavora con diverse funzioni simili oppure quando sviluppo una libreria di funzioni ( modulo esterno ) destinata a essere utilizzata anche da altri sviluppatori..

     


     

    Segnalami un errore, un refuso o un suggerimento per migliorare gli appunti

    FacebookTwitterLinkedinLinkedin
    knowledge base

    Le funzioni in python