Le livre "Clean Code" de Robert C. Martin (Uncle Bob) débute par une réflexion essentielle : qu'est-ce que le code propre et pourquoi est-ce important ? Ce premier chapitre pose les fondements de la philosophie du clean code en présentant les perspectives de plusieurs développeurs expérimentés et en expliquant pourquoi la propreté du code est cruciale pour la réussite des projets logiciels.
Points essentiels à retenir:
- Le code propre est lisible, maintenable et expressif
- Un bon code est aussi important que la fonctionnalité qu'il offre
- La propreté du code est une responsabilité professionnelle
- Un développeur professionnel doit adhérer à la discipline du clean code
1. Qu'est-ce que le Code Propre ?
Robert C. Martin commence par interroger plusieurs experts de l'industrie sur leur définition du code propre. Chacun apporte une vision unique mais complémentaire :
Selon Bjarne Stroustrup (créateur de C++)
Pour Stroustrup, le code propre fait une chose bien. Il est direct, efficace et élégant. Il doit être lisible et ne doit pas contenir de surprises désagréables. Le code propre doit être attentif aux détails et doit gérer proprement les cas limites.
Selon Grady Booch (auteur de "Object-Oriented Analysis and Design")
Booch considère que le code propre devrait se lire comme de la prose bien écrite. Il doit raconter une histoire claire et convaincante. Il ne doit pas masquer l'intention du programmeur mais révéler clairement les structures de conception.
Selon "Big" Dave Thomas (fondateur de OTI)
Thomas met l'accent sur la facilité de maintenance : un code propre est celui qu'un autre développeur peut facilement lire et modifier. Il laisse le code plus propre qu'il ne l'a trouvé (principe du Boy Scout).
Selon Michael Feathers (auteur de "Working Effectively with Legacy Code")
Pour Feathers, le code propre semble avoir été écrit par quelqu'un qui s'en soucie. Il n'y a rien d'évident que vous auriez pu faire pour le rendre meilleur.
2. Pourquoi le Code Propre est important
Uncle Bob explique que nous avons tous été confrontés à des situations où le code sale (ou "code smell") a ralenti notre productivité et augmenté les risques d'erreurs. Il présente plusieurs arguments convaincants sur l'importance du code propre :
La productivité à long terme
Le code propre permet de maintenir une vitesse de développement constante sur le long terme. À l'inverse, un code mal écrit ralentit inévitablement l'équipe au fil du temps, jusqu'à parfois complètement paralyser le développement.
Le coût de la dette technique
Chaque raccourci pris et chaque portion de code bâclée s'accumulent comme une dette. Plus cette dette technique s'accumule, plus les intérêts à payer deviennent élevés sous forme de bugs difficiles à corriger et de fonctionnalités complexes à implémenter.
La professionnalisme
Uncle Bob insiste sur le fait qu'écrire du code propre est une question de professionnalisme. Un bon développeur ne laisse pas un code médiocre en production, tout comme un chirurgien ne laisserait pas d'éponges dans le corps d'un patient après une opération.
Exemple : Avant et après refactoring
// Code non propre
function getUserData(id) {
let d = getFromDb(id);
if(d!=null) {
let n = d.name;
let e = d.email;
let a = d.address;
return {n,e,a};
}
return null;
}
// Code propre
function getUserData(userId) {
const user = fetchUserFromDatabase(userId);
if (!user) {
return null;
}
return {
name: user.name,
email: user.email,
address: user.address
};
}
3. La Règle du Boy Scout
Un concept particulièrement marquant introduit dans ce chapitre est la "Règle du Boy Scout" : "Laissez le campement plus propre que vous ne l'avez trouvé". Appliqué au code, cela signifie que chaque développeur devrait laisser le code un peu meilleur après y avoir touché.
Application progressive
Uncle Bob ne suggère pas de refactoriser entièrement une base de code d'un coup, mais plutôt d'améliorer progressivement le code existant à chaque fois qu'on y touche. Ces petites améliorations continues peuvent, au fil du temps, transformer même la base de code la plus problématique.
La discipline collective
Pour que cette approche fonctionne, toute l'équipe doit adhérer à ces principes. Un seul développeur négligent peut rapidement annuler les efforts de toute une équipe pour maintenir un code propre.
La règle des 30 minutes : Si vous passez 30 minutes à comprendre un morceau de code, prenez le temps de le refactoriser pour le rendre plus clair pour la prochaine personne (ou pour vous-même dans le futur).
4. Le Coût de la Saleté
Le chapitre se termine sur une réflexion concernant le coût réel d'un code mal écrit. Uncle Bob présente le concept de la "théorie des fenêtres cassées" appliquée au développement logiciel :
Effet d'entraînement
Un code mal écrit encourage davantage de mauvais code. Lorsqu'un développeur voit que le reste de la base de code est négligé, il sera moins enclin à maintenir des standards élevés pour sa propre contribution.
Ralentissement progressif
Au début d'un projet, l'équipe peut avancer rapidement même avec un code médiocre. Mais avec le temps, la complexité et les interdépendances rendent chaque changement de plus en plus risqué et chronophage.
Le mythe de la "livraison rapide"
Uncle Bob réfute l'idée selon laquelle écrire du code propre prend plus de temps. Il soutient qu'à court terme, la différence de vitesse est négligeable, tandis qu'à long terme, le code propre permet de maintenir une cadence de développement soutenue.
Estimation du coût de la dette technique
/*
* Estimation en heures pour un projet de taille moyenne (1 an) :
*
* Avec code propre :
* - Développement initial : 1000h
* - Maintenance an 1 : 200h
* - Nouvelles fonctionnalités an 1 : 800h
* Total : 2000h
*
* Avec code non propre :
* - Développement initial : 900h (-10%)
* - Maintenance an 1 : 600h (+200%)
* - Nouvelles fonctionnalités an 1 : 1200h (+50%)
* Total : 2700h
*
* Différence : +35% d'effort total
*/
À Retenir
- Code propre : Un code lisible comme une prose bien écrite, qui révèle clairement son intention et facilite la maintenance.
- Responsabilité professionnelle : Écrire du code propre est un devoir professionnel, non une option.
- Règle du Boy Scout : Toujours laisser le code un peu plus propre qu'on ne l'a trouvé.
- Dette technique : Un code mal écrit s'accumule et ralentit progressivement le développement jusqu'à le paralyser.
- Discipline collective : Maintenir un code propre nécessite l'adhésion et la discipline de toute l'équipe.