Table des matières
Ouvrir table des matières
Pourquoi vous DEVEZ faire du Clean Code ?
Lorsque l’on débute la programmation, l’objectif premier est de réaliser quelque chose qui fonctionne. On tente de mettre en pratique ce qu’on a appris pour obtenir un résultat. Et ça marche !
Alors on continue notre chemin dans notre apprentissage pour commencer à avoir une certaine confiance et aisance dans ce qu’on fait. On évolue et découvre le travail d’équipe.
Et on se rend vite compte que la programmation ce n’est pas juste faire du code pour que ça fonctionne.
On arrive donc à un stade où on commence à se poser des questions sur notre travail et sur notre façon de faire par rapport à ce que nous avons appris. On se remet continuellement en question.
N’y a-t-il pas une meilleure façon de faire que ce que j’ai réalisé ?
N’y a-t-il pas des méthodologies pour mieux s’organiser et y voir plus clair ?
Est-ce suffisamment bien écrit pour que quelqu’un d’autre comprenne ce que j’ai fait sans que je lui explique ?
C’est comme pour tout, il y a plusieurs façons de faire et de s’organiser. Certaines meilleures que d’autres et l’une d’entre elles pour la programmation c’est le Clean Code.
Le Clean Code, c’est quoi ?
Le Clean Code est une sorte de guide des bonnes pratiques en matière de codage.
Elle s’applique à tout niveau dans la programmation et c’est ce qui est intéressant. Il existe une multitude de points qui sont plus ou moins difficiles à mettre en place suivant votre expérience, mais aussi suivant votre volonté.
Ce qui est sûr c’est que si vous souhaitez progresser, avoir de l’aisance dans ce que vous faites et surtout de la fierté dans vos productions, alors c’est une étape obligatoire à franchir.
Le but du Clean Code est de vous permettre d’écrire du code plus propre, plus facile à lire et surtout mieux structuré. Le code que vous produisez doit pouvoir être lu et compris aisément par d’autres développeurs, peu importe leurs niveaux. Ce qui facilitera sa modification et son évolution pour les années à venir.
Alors oui du travail de bonne qualité, cela demande du temps de développement supplémentaire et de l’investissement personnel surtout si on n’a pas l’habitude d’en faire. Mais dîtes-vous bien que c’est un bon investissement en temps pour une application bien codée.
Il vous sera plus simple et plus facile de rajouter une nouvelle fonctionnalité dans un projet Clean Code que dans un projet au code douteux et aux parties obscures.
D’où vient la méthode Clean Code ?
Ils sont plusieurs à avoir créé cette méthode, mais la personne la plus connue publiquement pour le Clean Code c’est Robert C. Martin (surnommé Uncle Bob).
Il est l’auteur de nombreux livres et notamment l’un d’eux qui nous intéresse Clean Code: A Handbook of Agile Software Craftsmanship (en anglais). Il est également le fondateur du site Clean Coders.
Le site propose un ensemble de formations autour du « clean » comme pour ces livres. L’accès à chacun des cours complets coûte une centaine de dollars. Je vous assure que c’est vraiment un bon investissement au vu de ce que vous pouvez y apprendre et en tirer.
Je ne peux donc que vous conseiller le cours qui s’intitule Clean Code: Fundamentals que j’ai personnellement suivi. Les vidéos sont en anglais, mais Uncle Bob sait très bien imager son raisonnement et se mettre en évidence pour bien comprendre ce qu’il exprime.
Vous pourrez même voir qu’il adore se déguiser en mettant en place un ensemble de personnages et qu’il est un peu « taré » sur les bords ?. Ce qui rend ses cours beaucoup plus captivants et le personnage en lui même très sympathique.
Quelques concepts de bases du Clean Code à appliquer dès maintenant
Je ne pouvais pas vous parler du Clean Code sans vous donner quelques points de la méthode que vous pourrez appliquer dès votre prochaine session de codage.
Ce que je vous livre se trouve dans les premières vidéos du programme Clean Code Fundamentals.
Je tiens à préciser que ce que je vous délivre ne remplace pas le fait de voir son cours complet. Ces vidéos sont remplis d’exemples et d’images pour une meilleure compréhension et plus grande immersion.
Voyez ce que je vais vous expliquer comme un moyen de mettre en pratique des choses simples et des pistes pour approfondir le sujet.
Le nommage de vos variables
Le premier point à respecter c’est le bon nommage de vos variables. Et vous devez choisir vos noms de manière judicieuse et réfléchie.
Bannissez donc les variables avec juste 1 ou 2 lettres ou qui ne veulent rien dire. Le nom de votre variable doit communiquer son intention et son utilisation.
N’hésitez pas à prendre plusieurs minutes à trouver le bon nom de variable et qui plus est, un nom prononçable.
Prenons cet exemple :
let add1 = ‘';
let add2 =‘';À quoi servent ces variables ? C’est une adresse de facturation et de livraison ? Une adresse ligne 1 et ligne 2 ? On n’en sait rien vu comme ça alors que si on les nomme correctement :
let adresseDeFacturation = ‘';
let adresseDeLivraison =‘';Là on voit tout de suite de quoi on parle non ? C’est quand même plus efficace et plus compréhensif.
N’hésitez pas à produire des variables avec des noms à rallonge si nécessaire pour que l’on comprenne bien à quoi elle sert.
Optimiser ses fonctions
Oubliez les grosses fonctions remplies de code. Partez du principe qu’elles doivent être les plus petites possible.
Comment ?
Tout simplement en gardant en tête qu’une fonction doit réaliser UN seul traitement et pas plus. En gardant cette phrase en tête, vous serez en mesure de décomposer une grosse fonction qui fait beaucoup de choses en une multitude de petites fonctions qui feront chacune une seule chose.
Comme pour les variables, les fonctions doivent avoir des noms très clairs qui communiquent leurs intentions.
Une fonction est censée FAIRE quelque chose, elle doit TOUJOURS commencer par un verbe.
Évitez les fonctions avec plus de 3 paramètres en entrée.
Bannissez les variables d’entrée pouvant prendre comme valeur des booléens et des valeurs NULL.
Si vous présentez devoir utiliser un booléen en paramètre, c’est certainement que votre fonction peut être décomposée en 2 fonctions.
Utiliser judicieusement les commentaires
Gardez à l’esprit que les commentaires dans votre code doivent exister uniquement pour 3 buts précis :
- Placer un « todo », car il y a quelque chose à améliorer, à terminer ou à reporter
- Préciser une logique qui en apparence ne l’est pas,. Comme par exemple une contrainte métier qui fait que l’on est obligé de faire comme ça et que l’on ne peut pas faire autrement
- Pour des outils d’automatisation qui vous permettront de générer automatiquement certaines choses au niveau de votre application comme votre documentation par exemple
En clair, ne mettez plus de commentaires pour préciser ce que fait un morceau de code ou ce que signifie cette variable ou encore cette fonction.
Si vous pensez devoir le faire, c’est que vous n’avez pas appliqué les recommandations citées plus haut.
Livre blanc gratuit l’art de bien coder
Comme vous voyez, ce sont des choses assez simples à mettre en place et votre code sera déjà de meilleures qualités avec les différents points que je vous ai livré. Considérez cela comme le point de départ pour faire du Clean Code.
J’ai un cadeau pour vous : mon livre blanc l’art de bien coder. C’est un livre que j’ai écrit il y a quelques années et il vous donnera d’autres informations et astuces pour bien coder.
