Ton code dans trois mois
Tu écris un programme un soir. Trois mois plus tard, tu le rouvres. Plus rien n'a de sens : que veut dire x2 ? À quoi sert cette ligne ?
Un programme se lit bien plus souvent qu'il ne s'écrit. Il est lu par tes camarades, ton professeur, et toi-même plus tard.
Dans cette leçon, tu apprends à écrire du code qu'on comprend.
Mots-clés
| Mot | Ce que ça veut dire | Exemple |
|---|---|---|
| Nom clair | Un nom qui dit à quoi sert la variable ou la fonction. | prix_par_personne |
| Commentaire | Une ligne qui commence par #. Python l'ignore. Elle explique pourquoi. | # On arrondit aux centimes |
| Docstring | Un texte entre triples guillemets, au début d'une fonction. Il dit ce qu'elle fait. | """Rend la part de chacun.""" |
| Spécification | La description précise de ce que fait une fonction, sans montrer le calcul. | Ce qu'elle reçoit, ce qu'elle rend |
| Paramètre | Un nom entre parenthèses, après le nom de la fonction. Il reçoit une valeur. | total |
| Exemple d'appel | Un appel avec le résultat attendu, pour comprendre vite. | prix_par_personne(45, 4) rend 11.25 |
Les cellules que les étudiants remplissent restent vides dans cet aperçu.
À toi : deviner à quoi ça sert
def f(a, b):
c = a / b
return round(c, 2)
print(f(45, 4))
# Que fait cette fonction ? Impossible à deviner sans lire le calcul.
Choisir de bons noms
Un bon nom dit ce que c'est, pas comment on le calcule. prix_par_personne est clair. f ne dit rien.
On écrit en minuscules, avec des _ entre les mots. On évite les noms d'une lettre, sauf i dans une boucle.
Un nom un peu long qu'on comprend vaut mieux qu'un nom court qu'on devine.
Exemple travaillé : mauvais noms, bons noms
| Mauvais nom | Bon nom | Pourquoi |
|---|---|---|
| f | prix_par_personne | On sait ce que la fonction rend |
| a | total | On sait ce que la valeur représente |
| b | personnes | Le nom dit un nombre de personnes |
| x2 | prix_avec_taxe | Le nom dit le contenu, pas un numéro |
| liste | notes_de_la_classe | Le nom dit de quelle liste on parle |
Les cellules que les étudiants remplissent restent vides dans cet aperçu.
À toi : le même calcul, bien nommé
def prix_par_personne(total, personnes):
# On arrondit à deux décimales, comme les centimes d'euro.
part = total / personnes
return round(part, 2)
print(prix_par_personne(45, 4))
print(prix_par_personne(50, 3))
# Même calcul, mais on comprend tout. Essaie avec 60 euros et 5 amis.
Contrôle rapide
À toi de jouer
Contrôle rapide
3 questionsTes réponses sont corrigées ici et ne sont pas conservées. Un compte garde tes résultats.
La docstring
Un commentaire explique une ligne. La docstring décrit toute la fonction.
On l'écrit entre triples guillemets, juste après la ligne def. Python la garde en mémoire : on peut la relire avec nom.__doc__.
Les éditeurs la montrent quand on passe la souris sur le nom de la fonction.
La spécification en quatre questions
Une bonne docstring répond à quatre questions.
Que reçoit la fonction ? Que rend-elle ? Quel est un exemple ? Que se passe-t-il dans un cas particulier, comme zéro ou une liste vide ?
Celui qui lit n'a plus besoin de lire le calcul.