Le Clean Code en pratique dans le développement des logiciels Maarch

Introduction

Un code propre, autrement dit Clean Code, est essentiel pour garantir la longévité, la qualité et la facilité d’évolution des logiciels. Qu’est-ce que le Clean Code, les bénéfices qu’il apporte, ainsi que des exemples et des pratiques concrètes pour le rendre applicable et accessible ?

Un code bien structuré et lisible facilite non seulement la tâche des développeurs, mais optimise également les ressources, réduit les erreurs et accélère la mise en œuvre de nouvelles fonctionnalités.

Qu’est-ce qu’un code propre ?

Un Clean Code est un code qui est structuré, compréhensible et dépourvu de complexités inutiles. Il est organisé de manière à être lisible et maintenable par d’autres développeurs ou par soi-même après plusieurs mois, et ce, avec un minimum d’effort.

Un code propre est également évolutif et réutilisable, car il suit des règles simples qui facilitent son adaptation et son extension au fil du temps.

Il repose sur plusieurs principes de base :

• Simplicité : Chaque partie du code répond à une seule responsabilité bien définie.
• Lisibilité : Le code est compréhensible sans avoir besoin d’explications excessives.
• Maintenabilité : Il est facile à corriger, adapter et optimiser.
• Modularité : Le code est découpé en parties autonomes et réutilisables.

Schéma du concept de Clean Code

Les logiciels Maarch, étant des solutions open source, adhèrent aux principes du Clean Code pour rendre leur code source accessible et modulable.

Les avantages du code propre

Les avantages d’un code propre vont bien au-delà de l’esthétique. Ils sont cruciaux pour la réussite d’un projet logiciel.

1️⃣ Maintenabilité accrue

La maintenabilité est l’un des avantages les plus importants du Clean Code. Lorsque le code est bien structuré et facile à comprendre, il est beaucoup plus simple d’y revenir pour le corriger ou le mettre à jour.

Selon une étude de l’Université Carnegie Mellon, les entreprises qui investissent dans la maintenabilité de leur code réduisent de 30 à 50 % le temps passé en maintenance, ce qui se traduit par des économies significatives.

En pratique, cela signifie moins de bugs, des corrections plus rapides et une capacité accrue à faire évoluer le code sans le casser.

2️⃣ Réutilisabilité

Le code propre favorise la réutilisation, car chaque fonction ou module est indépendant et conçu pour remplir une tâche spécifique. Dans un contexte où l’on développe de multiples applications ou versions d’un produit, la réutilisation devient un atout stratégique.

3️⃣ Évolutivité et adaptabilité

Un code bien écrit et structuré est facile à faire évoluer. À mesure que les exigences changent, un code propre est suffisamment flexible pour permettre l’ajout de nouvelles fonctionnalités sans perturber l’existant.

4️⃣ Collaboration facilitée

Un Clean Code bien documenté facilite la collaboration au sein des équipes de développement. Dans les grandes entreprises comme Microsoft, où plusieurs équipes travaillent sur des projets communs, un code standardisé, lisible et bien organisé permet aux développeurs de comprendre rapidement les contributions des autres. La collaboration est alors facilitée, même en cas de turnover.

Meilleures pratiques pour un code propre

Un code propre ne dépend pas seulement de la compétence individuelle, mais repose sur des bonnes pratiques reconnues et éprouvées par tous.

1️⃣ Organisation du code

Architecture claire : adopter une architecture bien définie, telle que DDD (Domain Driven Design) ou l’architecture hexagonale, plus récente et utilisée pour la conception des produits tels que  Maarch Digital Flow.

Cette architecture permet une meilleure gestion des segments comme les dossiers, documents, utilisateurs, etc.

Cette architecture permet également deux choses, d’une part une séparation du code métier et du code qui « interagit » avec l’extérieur, et d’autre part l’aboutissement des tests plus simplement et rapidement pour tout code métier.

À savoir que l’ensemble de la solution Maarch Digital Flow est développé autour de cette structure hexagonale.

Exemple de structure hexagonale

Modularité : Découper les fonctions et classes en petits modules, afin que chacun d’entre eux soit  responsable d’une tâche précise.

Structure logique des dossiers : Organiser les fichiers et dossiers de façon cohérente pour faciliter la navigation et la lecture.

2️⃣ Nommer les variables et fonctions avec clarté

Utiliser des noms explicites : Les noms de variables et de fonctions doivent être clairs et décrire précisément leur fonction (par exemple, “Total Price” est plus explicite que “tp”).

Éviter les abréviations : Les abréviations peuvent être trompeuses et rendre le code incompréhensible. Privilégiez des noms complets et significatifs. Il en vaut de même pour les noms de code en situation de test.

Illustration de variable et fonction exposée avec clarté.

3️⃣ Commentaires et documentation

Commentaires succincts : Les commentaires concernant un test ou un code doivent être concis, informatifs et expliquer pourquoi le code fait ce qu’il fait. Un code propre est en soi explicite.

Documentation des fonctions : Documenter chaque fonction en indiquant ses paramètres, sa fonction et les éventuelles exceptions.

4️⃣ Techniques de débogage et de test

Il existe plusieurs types de tests essentiels pour garantir la qualité et la fiabilité du code.

Tests automatisés :

• Test unitaire : le test unitaire vérifie chaque fonction ou composant individuellement pour s’assurer qu’il fonctionne correctement en isolant ses fonctionnalités spécifiques. Par exemple, dans une application de messagerie, un test unitaire vérifiera qu’une fonction de formatage de data renvoie bien le format attendu. Ces tests doivent être mis en place dès les premières étapes du projet pour s’assurer de la qualité du code au fil du développement.
• Test fonctionnel:  le test fonctionnel évalue des fonctionnalités complètes de l’application en vérifiant que chaque composant fonctionne comme prévu en interaction avec  d’autres. Par exemple, dans une plateforme de gestion de documents comme MDF, un test fonctionnel pourrait vérifier qu’un utilisateur peut télécharger, consulter et partager un document de bout en bout, simulant ainsi un cas d’utilisation réel.

Codage itératif avec TDD (Test-Driven Development) :

La méthode TDD implique de concevoir un test pour chaque cas d’usage avant même d’écrire le code correspondant.

Cela pousse les développeurs à écrire un code plus structuré et maintenable, car chaque fonction est associée à un test spécifique, nommé de façon explicite.

Par exemple, si une fonction de tri est créée, un test sera écrit au préalable pour s’assurer qu’elle trie correctement une liste donnée. Cette approche facilite la compréhension pour les collaborateurs qui peuvent facilement repérer et interpréter chaque test.

Des outils tels que Jenkins, GitLab, ainsi que des solutions d’analyse de code comme SonarQube, facilitent la maintenabilité et la réutilisation du code tout en assurant son évolutivité.

Chez Maarch, nos équipes suivent des protocoles stricts en matière de tests : chaque développeur est tenu de vérifier que tous les tests associés à son code réussissent avant de le pousser dans la version finale. Cela garantit que chaque nouvelle version du code est stable, robuste et respecte les standards de qualité exigés.

Illustration de la méthode TDD

Refactoring régulier : le refactoring (réorganisation sans modifier le comportement) permet de simplifier le code sans altérer ses fonctionnalités. Martin Fowler, un pionnier dans le domaine, conseille un refactoring fréquent pour éviter l’accumulation de dettes techniques.

Conseils et stratégies pratiques pour améliorer la lisibilité et la maintenabilité du code

1️⃣ Simplifier le code autant que possible :

Éviter la complexité excessive. Utilisez des structures de code simples et logiques telles que la méthode KISS ( Keep It Simple Stupid).

2️⃣ Suivre les conventions de codage :

Utilisez les conventions propres au langage (camelCase en JavaScript, par exemple). Il existe de nombreuses conventions de codage, comme la convention PSR12 en PHP qui permet de vérifier que les développeurs respectent bien ce standard PHP.

Il est important de respecter les règles de codage de l’application et il est possible de vérifier certaines règles automatiquement.

Chez Maarch, c’est une méthode qui est utilisée au cours de la réalisation des bouts de code.

Illustration du camelCase en JavaScript

3️⃣ Éviter le code redondant :

Si un code similaire est répété plusieurs fois, envisager de le factoriser dans une fonction commune ; des méthodes telles que celle du DRY (Don’t Repeat Yourself) sont souvent utilisées.

4️⃣ Être attentif aux dépendances :

Utiliser le principe d’injection de dépendances pour garder le code flexible et permettre de tester des modules de manière isolée.

5️⃣ Relire le code :

Prendre le temps de revoir et de corriger le code avant de le fusionner dans le projet principal. Cette pratique est utilisée systématiquement au sein de Maarch  assurant la qualité  des éléments et du code.

Conclusion

Le Clean Code est une composante essentielle du développement logiciel moderne, offrant des avantages considérables en termes de maintenabilité, de réutilisation et d’évolutivité. Bien qu’il demande un effort initial et une discipline constante, les gains en productivité, en qualité et en satisfaction client sont inestimables.

L’adoption de principes de code propre a un impact direct et positif sur la performance de leurs services et la satisfaction des utilisateurs.

En suivant les bonnes pratiques et en intégrant le code propre dès le début d’un projet, les développeurs peuvent non seulement faciliter leur travail, mais aussi poser les bases d’un logiciel durable et évolutif.

C’est donc tout naturellement que ces principes sont mis en application au sein de l’équipe de R&D Maarch.