Développer un site web, c'est un peu comme écrire un livre. Imaginons que nous sommes 20 personnes, je raconte une histoire d'une minute, et je vous demande de la résumer à l'écrit en quelques lignes. Que nous soyons 20 personnes ou 20 000, chaque version sera unique et il est pratiquement impossible que deux soient exactement les mêmes. C'est exactement le même principe dans le code.
Puisqu'il y a autant de façons de coder que de façons de penser, il faut donc pouvoir s'y retrouver. En effet, imaginons qu'un autre développeur arrive, et qu'il doive modifier certaines parties de mon code. Est-ce qu'il arrivera facilement à lire et à comprendre mon travail ? Ou devra-t-il passer des heures à déchiffrer avent de pouvoir commencer à comprendre ?
Imaginons autre chose : Une fonctionnalité m'énerve, je suis bloqué et fatigué : j'ai envie de terminer rapidement pour pouvoir sortir ce soir. Je trouve une combinaison pas très homologuée mais qui tient la route, je vérifie que ça fonctionne, et hop je ferme mon ordinateur. Le lendemain, je continue mon travail sur cette base qui n'est pas bien faite. Trois mois plus tard je me rends compte que je dois modifier quelque chose, qui est lié à cette mauvaise fonctionnalité. Je vais donc devoir me replonger dans mon ancien travail, que je ne comprends plus car je ne sais plus pourquoi j'avais codé comme ça.
Bref, il est primordial de maintenir un code propre afin d'éviter les mals de crâne, les cachets d'aspirines, l'énervement et la démotivation. Coder est une chose, mais perdre des heures à déchiffres des hiéroglyphes en est une autre, bien moins drôle !
J'écris cet article car il m'est souvent arrivé de devoir reprendre un code complètement illisible : c'est chose horrible. Pour un travail qui pourrait être simple, fait en une demi heure, on peut passer des heures, les yeux rivés sur l'écran, qui deviennent rouges, à essayer de comprendre ce qui se passe dans ce programme.
Pourtant, il existe des méthodes simples pour maintenir un code propre :
- Regrouper le code en blocs espacés, réalisant chacun des fonctions distinctes,
- Mettre des commentaires bien sûr, afin d'indiquer ce que réalise chaque bloc de code,
- Respecter l'indentation, c'est à dire le nombre d'alinéats depuis la gauche,
- Utiliser des noms de variables en français : j'appelerai mon panier $panier et non pas $p,
- Idem pour les noms des fichiers, des fonctions, des classes, des tables en bases de données, etc...
Bref, beaucoup de petites choses simples à implémenter. Par exemple, si vous regardez l'image que j'ai choisie pour illustrer cet article, je suis sûr que même sans savoir coder, vous arrivez à déchiffrer ce qui se passe.
Oui, c'est un email,
Oui, c'est l'email que je reçois pour une demande de contact rapide lorque vous utilisez le petit bouton rouge en haut,
Et oui je reçois les coordonnées de la personne qui fait une demande de rappel.
Voilà, vous n'êtes peut-être pas développeur, mais c'est écrit en Français (et en Anglais je vous l'accorde), et c'est lisible ! Vous imaginez donc bien qu'un développeur qui devrait reprendre ce code comprendrait très vite comment il fonctionne.
Évidemment, j'ai pris un exemple extrèmement simpliste, c'est uniquement pour illustrer mon propos.
Je fais toujours mon maximum pour coder proporement car même dans le cas où aucun autre développeur ne repassera après moi, je pense au moi du futur, qui me remerciera d'avoir pensé à lui ???? Et ça m'est déjà arrivé souvent !
Commentaires