Documentazione
Principi di Ingegneria del Software in Python
Adam Spannbauer
Machine Learning Engineer at Eastman
Documentazione in Python
- Commenti
# Calcola il quadrato del numero x
- Docstring
"""Calcola il quadrato del numero x
:param x: numero da elevare al quadrato
:return: x al quadrato
>>> square(2)
4
"""
Commenti
# Questo è un commento valido
x = 2
y = 3 # Anche questo è un commento valido
# Non puoi vedermi a meno che non guardi il codice sorgente# Ciao futuri collaboratori!!
Commenti efficaci
Commentare 'cosa'
# Definisci persone come 5
people = 5
# Moltiplica persone per 3
people * 3
Commentare 'perché'
# Ci saranno 5 persone alla festa
people = 5
# Abbiamo bisogno di 3 pezzi di pizza per persona
people * 3
Docstring
def function(x):
"""Descrizione generale della funzione
Dettagli aggiuntivi sulla funzione
Docstring
def function(x):
"""Descrizione generale della funzione
Dettagli aggiuntivi sulla funzione
:param x: descrizione del parametro x
:return: descrizione del valore di ritorno
Pagina di esempio generata da una docstring nel pacchetto Flask.
Docstring
def function(x):
"""Descrizione generale della funzione
Dettagli aggiuntivi sulla funzione
:param x: descrizione del parametro x
:return: descrizione del valore di ritorno
>>> # Esempio di utilizzo della funzione
Risultato atteso dell'esempio di utilizzo
"""
# codice della funzione
Esempio di docstring
def square(x):
"""Calcola il quadrato del numero x
:param x: numero da elevare al quadrato
:return: x al quadrato
>>> square(2)
4
"""
# `x * x` è più veloce di `x ** 2`
# riferimento: https://stackoverflow.com/a/29055266/5731525
return x * x
Output esempio docstring
help(square)
square(x)
Calcola il quadrato del numero x
:param x: numero da elevare al quadrato
:return: x al quadrato
>>> square(2)
4
Facciamo pratica
Principi di Ingegneria del Software in Python
