"C'est quoi cette fonction calcul(a, b) que j'ai écrite il y a 6 mois ?"
Si tu n'as pas documenté, tu es perdu.
En Python, on utilise les Docstrings. C'est une chaîne de caractères triplée """ juste après la définition.
def surface_cercle(rayon):
"""
Calcule la surface d'un cercle.
Args:
rayon (float): Le rayon du cercle en mètres.
Returns:
float: La surface en mètres carrés.
"""
return 3.14 * (rayon ** 2)
Avantage : Quand tu survoles la fonction dans VS Code, cette doc apparaît ! ✨