Coder proprement

Avant d'aller plus loin, faut qu'on parle d'un truc important avant de prendre trop de mauvaises habitudes : coder proprement.

Car un code, ce n’est pas seulement pour l’ordinateur. C’est aussi (et surtout) pour vous dans 2 semaines et pour les autres (quand vous serez amené à faire des projets à plusieurs, ce qui va arriver).

On va donc voir quelques règles de bienséance.

Choisir de bons noms de variables

On en a déjà parlé, mais essayez d'éviter ceci :

a = 12
b = 5
c = a * b

Vous n’avez aucune idée de ce que ça représente.

Préférez des noms clairs :

prix_unitaire = 12
quantite = 5
prix_total = prix_unitaire * quantite

Beaucoup plus compréhensible.

---

Respiration du code

Aérez votre code !

def calculer_prix_total(prix, quantite):
    total = prix * quantite
    return total

print(calculer_prix_total(12, 5))

• Une ligne vide après la fonctions
• Pas de code tout collé

Vraiment ça sert à rien de vouloir économiser de la place en collant tout.

---

Une fonction = une idée

Si une fonction fait trop de choses, c’est mauvais signe.

Mauvais exemple :

def jeu():
    # demande nom
    # tire un nombre
    # boucle principale
    # affiche score
    # rejoue ?

Mieux :

def demander_nom():
    ...

def jouer_une_partie():
    ...

def afficher_score():
    ...

Votre programme devient compréhensible rien qu’en lisant les noms.

---

Commenter intelligemment

Vous en avez déjà vu dans ce parcours, mais on peut rajouter des commentaires (càd du texte non pris en compte par l'ordinateur) en écrivant un # ou en encadrant le texte par des '''.

De manière générale, les bons commentaires expliquent pourquoi, pas comment.

Mauvais commentaire :

x = x + 1   # j'ajoute 1 à x

Bon bah c'est pas un commentaire à se taper le cul par terre, tout le monde voit qu'on rajoute 1 à x.

Alors que ce commentaire est tout de suite plus clair :

x = x + 1   # on passe à la tentative suivante dans le jeu

Checklist du code propre

Question	Réponse attendue
Mes variables ont-elles des noms clairs ?	Oui
Mes fonctions sont-elles courtes ?	Oui
Est-ce que je pourrais comprendre ce code dans 3 semaines ?	Oui
Ai-je séparé calcul / affichage / interaction ?	Oui
Ai-je mis des commentaires seulement si nécessaires ?	Oui

Si vous répondez oui à tout, c’est propre.

En résumé

Coder proprement, c’est une habitude. Plus vous le faites tôt, plus vos futurs projets seront agréables à écrire.