{"id":9630,"date":"2023-12-07T10:05:20","date_gmt":"2023-12-07T09:05:20","guid":{"rendered":"https:\/\/blog.ouidou.fr\/?p=9630"},"modified":"2023-12-07T10:38:03","modified_gmt":"2023-12-07T09:38:03","slug":"clean-code-par-lexemple","status":"publish","type":"post","link":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple","title":{"rendered":"Clean code par l\u2019exemple"},"content":{"rendered":"\n<p class=\"has-text-color wp-block-paragraph\" style=\"color:#7c7676\"><em>Article \u00e9crit par Bastien<\/em><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Qu\u2019est ce que le clean code ?<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">En tant que dev, il vous est sans doute d\u00e9j\u00e0 arriv\u00e9 de devoir d\u00e9velopper une fonctionnalit\u00e9, pourtant simple, mais de patauger \u00e0 cause d\u2019un code existant de mauvaise qualit\u00e9.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Petite d\u00e9finition :<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\u201c<strong>Le clean code (code propre)<\/strong> est une approche de programmation qui se concentre sur l\u2019\u00e9criture de code <strong>clair<\/strong>, <strong>lisible<\/strong> et <strong>facilement maintenable<\/strong>.\u201d<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Les raisons qui peuvent pousser \u00e0 vouloir faire cela sont multiples.<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>D\u2019un point de vue de l\u2019entreprise, la premi\u00e8re motivation est<strong> financi\u00e8re<\/strong>. Un code clean est plus facile \u00e0 prendre en main. On peut ainsi r\u00e9duire drastiquement les temps pass\u00e9s \u00e0 comprendre le code et \u00e0 l\u2019enrichir. Cons\u00e9quence : sur le long terme on produit plus et mieux, pour une dur\u00e9e \u00e9gale.<\/li><li>D\u2019un point de vue du d\u00e9veloppeur, on peut prendre du plaisir \u00e0 adopter une d\u00e9marche d\u2019artisan logiciel \u201c<em><strong>Software Craftsmanship<\/strong>\u201d<\/em>, et \u00e0 cr\u00e9er des logiciels robustes. A contrario, maintenir un mauvais code peut \u00eatre source de stress et de frustration.<\/li><\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"#entrons-dans-le-vif-du-sujet\"><\/a>Entrons dans le vif du sujet<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\"><em>Code \u201cclair\u201d, code \u201clisible\u201d, code \u201cmaintenable\u201d. D\u2019accord. Mais qu\u2019est-ce que \u00e7a signifie au juste ?<\/em><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Dans la suite de cet article je vais essayer d\u2019expliciter ces termes, qui peuvent sembler un peu flous au premier abord. Pour ce faire, je vais me baser sur des exemples (r\u00e9els) de code que j\u2019ai eu l\u2019occasion de rencontrer.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Voici un extrait de code issu de la partie front-end d\u2019une application javascript (framework AngularJS) sur laquelle il m\u2019a \u00e9t\u00e9 demand\u00e9 de travailler :<\/p>\n\n\n\n<pre id=\"code-54\" class=\"wp-block-code\"><code>\/\/ Methode pour creer le profil de l\u2019utilisateur  \n$scope.create = function (idDemande) {  \n $log.debug('ModalInstanceGestionDemandesCtrl.create(' + idDemande + ')');  \n blockUI.start();  \n \/\/ GestionDemandesService.accepter(idDemande, $rootScope.currentUser.idProfil, 'CREATE', demandeAp).success(function() {  \n GestionDemandesService.accepter($scope.demande).then(function() {  \n  GrowlService.manageSuccess(i18n.commons.articles.La + i18n.profil.demande + i18n.commons.messages.success\\_create\\_f);  \n }).catch(function() {  \n  GrowlService.manageError(i18n.commons.messages.error\\_create);  \n }).finally(function() {  \n  blockUI.stop();  \n  $modalInstance.dismiss('create');  \n  if(!$scope.fromDemandeAp){  \n   \/\/Envoi vers la page de modification des habilitations du user.  \n   $state.go('habilitation-edition',{id : idDemande});  \n  } else {   \n   \/\/R\u00e9cup\u00e9ration de l'entite par le profil  \n   $state.go('demandes-ap-edition',  \n   {  \n    codeEntite : $scope.demande.codeEntite  \n   });  \n  }  \n });  \n};<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Sans m\u00eame \u00eatre d\u00e9veloppeur AngularJS, certaines choses vous ont peut-\u00eatre agac\u00e9.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Reprenons quelques points faciles \u00e0 mettre en place et qui peuvent grandement vous aider \u00e0 produire un code de meilleure qualit\u00e9.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"#commentaires\"><\/a>Commentaires<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Les commentaires dans le code peuvent contribuer \u00e0 faciliter la lecture et la compr\u00e9hension du code. Attentions toutefois \u00e0 ne pas tomber dans certains travers : il m\u2019est arriv\u00e9 de voir des blocs de dizaines de lignes comment\u00e9s accompagn\u00e9s de TODO vieux de plusieurs ann\u00e9es, et qui ne seront probablement jamais d\u00e9 comment\u00e9s, ni m\u00eame utilis\u00e9s. G\u00e9n\u00e9ralement, c&rsquo;est du code \u00e0 supprimer. Au pire, ce code sera toujours pr\u00e9sent dans les m\u00e9andres de votre syst\u00e8me de versionning, et jamais totalement perdu.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\u00c9viter les commentaires inutiles. Il m\u2019est arriv\u00e9 de tomber sur une classe Java dans laquelle chaque accesseur (getter et setter) \u00e9tait pr\u00e9c\u00e9d\u00e9 d\u2019un commentaire. De tels commentaires n\u2019apportent rien si ce n\u2019est des lignes superflues.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Dans mon extrait de code ci-dessus, j&rsquo;ai ce commentaire, inutile et inchang\u00e9 depuis 2019, je supprime :<\/p>\n\n\n\n<pre id=\"code-55\" class=\"wp-block-code\"><code> \/\/ GestionDemandesService.accepter(idDemande, $rootScope.currentUser.idProfil, 'CREATE', demandeAp).success(function() <\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Quelques bonnes pratiques pour les commentaires :<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>Commentez avec parcimonie, uniquement pour d\u00e9crire les parties du code les plus complexes.<\/li><li>Utilisez un style de commentaire uniforme.<\/li><li>De fa\u00e7on g\u00e9n\u00e9rale, utilisez les commentaires pour d\u00e9crire les motivations qui vous poussent \u00e0 \u00e9crire une section de code. <strong>Commenter le \u201cpourquoi ?\u201d plut\u00f4t que le \u201ccomment ?\u201d.<\/strong><\/li><\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"#naming-des-fonctions-et-variables\"><\/a>Naming des fonctions et variables<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Parfois, en nommant intelligemment une fonction ou une variable, on se dispense de l\u2019utilisation d\u2019un commentaire. Dans le code ci-dessus, j\u2019ai une m\u00e9thode \u201ccreate\u201d (l.2) pr\u00e9c\u00e9d\u00e9e d\u2019un commentaire.<\/p>\n\n\n\n<pre id=\"code-56\" class=\"wp-block-code\"><code>\/\/ Methode d'acceptation de la demande  \n $scope.create = function (idDemande) {<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Ne serait-il pas plus judicieux de donner un nom plus explicite \u00e0 la m\u00e9thode, de fa\u00e7on \u00e0 pouvoir se passer de commentaire ? Dor\u00e9navant au clic sur mon bouton, j&rsquo;appelle la m\u00e9thode :<\/p>\n\n\n\n<pre id=\"code-57\" class=\"wp-block-code\"><code>$scope.handleCreateProfil = function() {<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Avec un tel nom, \u201cce que fait la m\u00e9thode\u201d saute imm\u00e9diatement aux yeux; ne pas h\u00e9siter \u00e0 assembler plusieurs mots.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Quelques conseils de nommage :<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><strong>Lorsque c\u2019est possible<\/strong>, utiliser la langue anglaise. Cela vaut pour le nommage de variable, de m\u00e9thode (et plus g\u00e9n\u00e9ralement cela peut \u00eatre une bonne pratique pour les messages de commit, les reviews git, les recherches techniques sur Google\u2026)<\/li><li>Respecter les conventions de casse propre \u00e0 votre langage (CamelCase, lowerCamelCase, snake_case\u2026), (thanks captain obvious).<\/li><li>Utilisez des verbes pour d\u00e9crire le comportement de m\u00e9thodes, des substantifs\/noms pour d\u00e9crire des variables.<\/li><li>Utilisez un vocabulaire pr\u00e9cis, adapt\u00e9 en fonction de votre type de donn\u00e9e. Si vous manipulez un bool\u00e9en, pr\u00e9c\u00e9dez-le d\u2019un pr\u00e9fixe \u201cis\u201d, \u201cshould\u201d, \u201chas\u201d\u2026 Evitez par exemple le nom \u201cflag\u201d, trop vague, pr\u00e9ferez quelque chose comme \u201cisFlagValid\u201d.<\/li><\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"#single-responsibility-principle-ou-srp-et-autres-principes-solid\"><\/a>Single Responsibility Principle (ou SRP) et autres principes SOLID<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">En programmation orient\u00e9e objet, le principe de responsabilit\u00e9 unique consiste \u00e0 ne donner qu\u2019une responsabilit\u00e9 \u00e0 une classe ou \u00e0 une m\u00e9thode. En ne respectant pas ce principe, on peut se retrouver avec des classes ou des m\u00e9thodes \u201cfourre-tout\u201d de centaines (ou milliers) de lignes.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Les cons\u00e9quences peuvent \u00eatre nombreuses :<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>Complexit\u00e9 accrue, le code devient plus complexe \u00e0 comprendre, \u00e0 maintenir et \u00e0 modifier.<\/li><li>Fort couplage, le code est moins testable unitairement, on augmente les risques d\u2019effets de bords impr\u00e9vus.<\/li><li>Code peu r\u00e9utilisable<\/li><li>Code difficilement maintenable<\/li><\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Le SRP est l\u2019un des cinq principes SOLID promus par l\u2019ing\u00e9nieur logiciel am\u00e9ricain Robert C. Martin. Difficile de concevoir un article sur le clean code, sans a minima les \u00e9voquer.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Dans mon code initial j\u2019ai par exemple une clause <em>finally<\/em> qui impl\u00e9mente une fonction anonyme :<\/p>\n\n\n\n<pre id=\"code-58\" class=\"wp-block-code\"><code>.finally(function() {  \n  blockUI.stop();  \n  $modalInstance.dismiss('create');  \n  if(!$scope.fromDemandeAp){  \n   \/\/Envoi vers la page de modification des habilitations du user.  \n   $state.go('habilitation-edition',{id : idDemande});  \n  } else {   \n   \/\/R\u00e9cup\u00e9ration de l'entite par le profil  \n   $state.go('demandes-ap-edition',  \n   {  \n    codeEntite : $scope.demande.codeEntite  \n   });  \n  }  \n });<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Je peux extraire cette impl\u00e9mentation dans une m\u00e9thode s\u00e9par\u00e9e <em>dismissModal<\/em> et l\u2019utiliser de la fa\u00e7on suivante&nbsp;:<\/p>\n\n\n\n<pre id=\"code-59\" class=\"wp-block-code\"><code>.finally(() =&gt; dismissModal(closeModalLogMessage))<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">En proc\u00e9dant ainsi, on rend le code plus lisible, on enl\u00e8ve un niveau d\u2019imbrication et la logique impl\u00e9ment\u00e9e dans ma m\u00e9thode <em>dismissModal<\/em> est r\u00e9utilisable ailleurs. Dans le cas de mon application, j&rsquo;ai plusieurs boutons, qui ont des comportements tr\u00e8s proches. Je ne vais pas m\u2019amuser \u00e0 \u00e9crire quasiment le m\u00eame code pour chaque bouton, je g\u00e9n\u00e9ralise autant que possible ce qui peut l\u2019\u00eatre\u202f; ainsi mon code est factoris\u00e9 et plus facilement maintenable.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">J\u2019ai d\u00e9taill\u00e9 ci-dessus le principe de SRP; les 4 autres principes SOLID sont :<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><strong>Le \u201cOpen\/Closed Principle\u201d :<\/strong> Il s\u2019agit de faire en sorte d\u2019avoir des entit\u00e9s (composants, classes, m\u00e9thodes) ferm\u00e9s \u00e0 la modification, mais ouverts \u00e0 l\u2019extension.<\/li><li><strong>Liskov Substitution Principle :<\/strong> Ce principe dit qu\u2019un object de type A doit pouvoir \u00eatre remplac\u00e9 par un objet de type B si B est un sous type de A, et cela ne doit pas perturber la coh\u00e9rence du programme.<\/li><li><strong>Interface Segregation Principle :<\/strong> Ce principe stipule qu\u2019il vaut mieux diviser les interfaces utilisateurs en sous-interfaces plus petites et sp\u00e9cialis\u00e9es. Les utilisateurs ne doivent pas \u00eatre forc\u00e9s d\u2019interagir avec des m\u00e9thodes ou des fonctionnalit\u00e9s qu\u2019ils n\u2019utilisent pas.<\/li><li><strong>Dependency Inversion Principle :<\/strong> Ce principe stipule que les modules de bas niveau ne doivent pas d\u00e9pendre des modules de haut niveau. Au lieu de cela, les deux niveaux de modules doivent d\u00e9pendre d\u2019une abstraction commune.<\/li><\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Je conseille de lire un peu \u00e0 ce sujet. Ces principes peuvent \u00eatre un peu compliqu\u00e9s \u00e0 assimiler (\u00e0 titre personnel le principe d\u2019inversion de d\u00e9pendances me pose encore un probl\u00e8me). Si vous ne parvenez pas \u00e0 les utiliser dans l\u2019imm\u00e9diat, c&rsquo;est normal, mais petit-\u00e0-petit vous vous rendrez compte que cette fa\u00e7on de coder sera de plus en plus naturelle.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"#norme-de-coding\"><\/a>Norme de coding<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Bien qu\u2019elles soient propres \u00e0 chaque langage, on peut s\u2019accorder sur certaines conventions communes qui am\u00e9liorent la lisibilit\u00e9 du code.<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>On devrait \u00e9viter tant que possible les m\u00e9thodes \u201ctrop longues\u201d, qui sortent de l\u2019\u00e9cran et demandent de scroller. Par exemple : pas plus de 80 colonnes de largeur dans le code, 25 lignes max par fonction. Si votre code respecte bien les principes SOLID et que votre code est bien d\u00e9coup\u00e9, cela ne devrait pas \u00eatre un probl\u00e8me.<\/li><li>Variables d\u00e9finies dans un scope appropri\u00e9, on n\u2019utilise pas de variables globales si leur port\u00e9e r\u00e9elle ne concerne qu\u2019une toute petite feature tr\u00e8s locale.<\/li><li>Ajout d\u2019espaces avant et apr\u00e8s les op\u00e9rateurs binaires (=, +, -, \/, %),<\/li><li>Retours et sauts de lignes, respect des indentations\u2026<\/li><li>Pas trop de param\u00e8tres pour une m\u00e9thode. Certains d\u00e9veloppeurs estiment qu\u2019une m\u00e9thode ne devrait pas avoir plus de 2 ou 3 param\u00e8tres.<\/li><\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Voici un aper\u00e7u de mon code \u00e0 l\u2019issue de ma refactorisation :<\/p>\n\n\n\n<pre id=\"code-60\" class=\"wp-block-code\"><code>$scope.handleCreateProfil = function() {  \n let logMessage = i18n.commons.messages.logProfilCreation;  \n let successMessage = i18n.commons.messages.profilCreationSuccess;  \n let errorMessage = i18n.commons.messages.profilCreationFailure;  \n let closeModalLogMessage = i18n.commons.message.closeModalMessage;  \n   \n prepareModal(logMessage);  \n   \n GestionDemandesService.createProfil($scope.demande)  \n .then(() =&gt; displaySuccessMessage(successMessage))  \n .catch(() =&gt; displayErrorMessage(errorMessage))  \n .finally(() =&gt; dismissModal(closeModalLogMessage));  \n };<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Plus lisible que le code d\u2019origine, n\u2019est-ce pas ?<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Vous noterez quelques d\u00e9tails :<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>Initialement les cha\u00eenes de caract\u00e8res issues de l\u2019<strong>i<\/strong>nternationalisatio<strong>n<\/strong> (i18n) \u00e9taient atomis\u00e9es \u00e0 un degr\u00e9 bien trop important. De fa\u00e7on g\u00e9n\u00e9rale attention \u00e0 ne pas \u201csur-d\u00e9couper\u201d le code; arriv\u00e9 \u00e0 un certain niveau, cela peut nuire \u00e0 la qualit\u00e9.<\/li><li>Je n\u2019ai plus de commentaires, et mon code est tout \u00e0 fait lisible et compr\u00e9hensible (du moins j\u2019esp\u00e8re ^^)<\/li><li>J\u2019ai une moindre profondeur au niveau imbrications; fini les if\/else sur 4 niveaux.<\/li><li>Les impl\u00e9mentations de mes m\u00e9thodes de callbacks \u201cthen\u201d,\u201dcatch\u201d, \u201cfinally\u201d sont d\u00e9l\u00e9gu\u00e9es \u00e0 d\u2019autres m\u00e9thodes que je r\u00e9utilise ailleurs.<\/li><li>La plupart des modifications que j\u2019ai faites ne demandent pas de grosse comp\u00e9tence d\u2019architecture logicielle. Mon exemple ne concerne qu\u2019un seul fichier.<\/li><\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"#pour-finir\"><\/a>Pour finir<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">J\u2019ai essay\u00e9 de vous partager au travers de cet article quelques exemples de bonnes pratiques \u201csimples\u201d que j\u2019essaye d\u2019appliquer d\u00e8s que possible pour produire du code plus facilement maintenable (et esth\u00e9tiquement plus joli :D).<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Parfois la r\u00e9alit\u00e9 nous rappelle \u00e0 l\u2019ordre : d\u00e9lais \u00e0 respecter, code existant inintelligible et sensible aux r\u00e9gressions, car peu test\u00e9 unitairement, collaborations difficiles entre les personnes\u2026 Autant de choses qui peuvent freiner \u00e0 faire les choses \u201cbien\u201d. On peut pester contre le code existant et les anciens d\u00e9veloppeurs, mais il ne faut pas oublier qu\u2019eux aussi ont peut-\u00eatre travaill\u00e9 dans un contexte compliqu\u00e9.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">D\u2019un point de vue du client, la refactorisation de code n\u2019ajoute aucune valeur \u00e0 un produit \u00e0 court terme. Pour cette raison, elle est souvent non prioris\u00e9e. En revanche, on peut (et on devrait) travailler cet aspect en t\u00e2che de fond lorsque l\u2019on travaille sur le d\u00e9veloppement d\u2019une features (renommer une variable, modifier un commentaire ne sont pas des t\u00e2ches tr\u00e8s chronophages).<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Enfin, ne vous attendez pas \u00e0 devenir expert du clean code en quelques jours, c\u2019est un travail de long terme. Laissez-vous le temps d\u2019apprendre, lire de la th\u00e9orie, c&rsquo;est bien, mais rien ne vaut de la pratique, beaucoup de pratique.<\/p>\n\n\n\n<figure class=\"wp-block-image\"><a href=\"https:\/\/narcisse.synbioz.com\/attachments\/0b599393-8266-4fe4-a3c8-df8454af6870\/variants\/fa5d84eb-c390-48fc-9d90-5dcdaf7358e8\/src\" target=\"_blank\" rel=\"noreferrer noopener\"><img decoding=\"async\" src=\"https:\/\/narcisse.synbioz.com\/attachments\/0b599393-8266-4fe4-a3c8-df8454af6870\/variants\/fa5d84eb-c390-48fc-9d90-5dcdaf7358e8\/src\" alt=\"clean code\n\"\/><\/a><figcaption>Illustration de l\u2019effet Dunning-Kruger, source Wikipedia.<\/figcaption><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\">Pour progresser, attention \u00e0 l\u2019exc\u00e8s de confiance. (Et \u00e0 l\u2019inverse, gare au syndrome de l\u2019imposteur !)<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><a href=\"#quelques-ressources-pour-aller-plus-loin\"><\/a>Quelques ressources pour aller plus loin\u2026<\/h2>\n\n\n\n<ul class=\"wp-block-list\"><li>Voir principes <a rel=\"noreferrer noopener\" href=\"https:\/\/en.wikipedia.org\/wiki\/KISS_principle#:~:text=The%20principle%20is%20best%20exemplified,conditions%20with%20only%20these%20tools.\" target=\"_blank\">KISS (Keep It Simple Stupid)<\/a>, [DRY (Don\u2019t repeat yourself)](<a rel=\"noreferrer noopener\" href=\"https:\/\/fr.wikipedia.org\/wiki\/Ne_vous_r%C3%A9p%C3%A9tez_pas#:~:text=Ne%20vous%20r%C3%A9p%C3%A9tez%20pas%20(don,les%20%C3%A9volutions%20de%20cette%20derni%C3%A8re.)\" target=\"_blank\">https:\/\/fr.wikipedia.org\/wiki\/Ne_vous_r%C3%A9p%C3%A9tez_pas#:~:text=Ne%20vous%20r%C3%A9p%C3%A9tez%20pas%20(don,les%20%C3%A9volutions%20de%20cette%20derni%C3%A8re.)<\/a>, <a rel=\"noreferrer noopener\" href=\"https:\/\/fr.wikipedia.org\/wiki\/Loi_de_D%C3%A9m%C3%A9ter\" target=\"_blank\">Loi de D\u00e9meter<\/a><\/li><li>Bon article sur le <a rel=\"noreferrer noopener\" href=\"https:\/\/medium.com\/@kedren.villena\/simplifying-dependency-inversion-principle-dip-59228122649a\" target=\"_blank\">Dependency Inversion Principle<\/a> (SOLID)<\/li><li><a rel=\"noreferrer noopener\" href=\"https:\/\/stackoverflow.blog\/2021\/12\/23\/best-practices-for-writing-code-comments\/\" target=\"_blank\">Articles bonnes pratiques commentaires<\/a><\/li><li>Article \u201c<a rel=\"noreferrer noopener\" href=\"https:\/\/dev.to\/sandricoprovo\/how-to-write-cleaner-if-statements-in-javascript-2c0m\" target=\"_blank\">How to Write Cleaner If Statements In JavaScript<\/a>\u201d<\/li><li>Il existe des outils d\u2019analyse de code, par exemple SonarQube, qui peut \u00eatre integr\u00e9 \u00e0 Jenkins. Voir article <a rel=\"noreferrer noopener\" href=\"https:\/\/ouidou.fr\/blog\/sonarqube-un-analyseur-de-code-statique-b79d78651d52\" target=\"_blank\">SonarQube sur le Medium Ouidou<\/a>.<\/li><li>Quelques bonnes pratiques de d\u00e9veloppement qui m\u00e9ritent de s\u2019y int\u00e9resser : les tests unitaires (et le TDD, pour Test Driven Development), la revue de code, la documentation, les design pattern.<\/li><\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Quelques livres pour les plus motiv\u00e9s:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><em>Clean Code: A Handbook of Agile Software Craftsmanship<\/em> (Robert Martin). Tr\u00e8s bon ouvrage, souvent consid\u00e9r\u00e9 comme la r\u00e9f\u00e9rence sur le sujet. Lecture accessible, m\u00eame en anglais, il existe une traduction fr. Il y a des chapitres complets sur le naming de variables, les commentaires. En survolant cet ouvrage m\u00eame quelques minutes, vous devriez apprendre un tas de choses utiles. Je recommande vraiment, quel que soit votre niveau en dev !<\/li><li><em>Head First Design Patterns<\/em> (Eric Freeman, Kathy Sierra). Je ne les ai pas \u00e9voqu\u00e9s dans cet article, mais les design pattern sont g\u00e9n\u00e9ralement des bonnes pratiques pour cr\u00e9er un code de qualit\u00e9. Ils peuvent \u00eatre un peu difficiles \u00e0 appr\u00e9hender et demandent un temps d\u2019assimilation assez cons\u00e9quent. Ce livre est bien illustr\u00e9 et se base sur des exemples de code intelligibles et tr\u00e8s concrets.<\/li><\/ul>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Article \u00e9crit par Bastien Qu\u2019est ce que le clean code ? En tant que dev, il vous est sans doute d\u00e9j\u00e0 arriv\u00e9 de devoir d\u00e9velopper une<span class=\"excerpt-hellip\"> [\u2026]<\/span><\/p>\n","protected":false},"author":10,"featured_media":11764,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"content-type":"","inline_featured_image":false,"fifu_image_url":"","fifu_image_alt":"","footnotes":""},"categories":[34],"tags":[],"class_list":["post-9630","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-articles-techniques"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.9 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Clean code par l\u2019exemple - Ouidou<\/title>\n<meta name=\"description\" content=\"D\u00e9couvrez le clean code, une approche de programmation qui se concentre sur l\u2019\u00e9criture de code clair, lisible et facilement maintenable.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple\" \/>\n<meta property=\"og:locale\" content=\"fr_FR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Clean code par l\u2019exemple - Ouidou\" \/>\n<meta property=\"og:description\" content=\"D\u00e9couvrez le clean code, une approche de programmation qui se concentre sur l\u2019\u00e9criture de code clair, lisible et facilement maintenable.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple\" \/>\n<meta property=\"og:site_name\" content=\"Ouidou\" \/>\n<meta property=\"article:published_time\" content=\"2023-12-07T09:05:20+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2023-12-07T09:38:03+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/ouidou.fr\/blog\/wp-content\/uploads\/2023\/12\/De\u0301ploiement-dune-stack-comple\u0300te-de-test-automatise\u0301-avec-Squash.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1105\" \/>\n\t<meta property=\"og:image:height\" content=\"564\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Sara Lourties\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"\u00c9crit par\" \/>\n\t<meta name=\"twitter:data1\" content=\"Sara Lourties\" \/>\n\t<meta name=\"twitter:label2\" content=\"Dur\u00e9e de lecture estim\u00e9e\" \/>\n\t<meta name=\"twitter:data2\" content=\"11 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple\"},\"author\":{\"name\":\"Sara Lourties\",\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/#\\\/schema\\\/person\\\/e1d66085fb7c22ede319ce56adc373a4\"},\"headline\":\"Clean code par l\u2019exemple\",\"datePublished\":\"2023-12-07T09:05:20+00:00\",\"dateModified\":\"2023-12-07T09:38:03+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple\"},\"wordCount\":2068,\"publisher\":{\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/#organization\"},\"image\":{\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/wp-content\\\/uploads\\\/2023\\\/12\\\/De\u0301ploiement-dune-stack-comple\u0300te-de-test-automatise\u0301-avec-Squash.png\",\"articleSection\":[\"Articles Techniques\"],\"inLanguage\":\"fr-FR\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple\",\"url\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple\",\"name\":\"Clean code par l\u2019exemple - Ouidou\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/wp-content\\\/uploads\\\/2023\\\/12\\\/De\u0301ploiement-dune-stack-comple\u0300te-de-test-automatise\u0301-avec-Squash.png\",\"datePublished\":\"2023-12-07T09:05:20+00:00\",\"dateModified\":\"2023-12-07T09:38:03+00:00\",\"description\":\"D\u00e9couvrez le clean code, une approche de programmation qui se concentre sur l\u2019\u00e9criture de code clair, lisible et facilement maintenable.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple#breadcrumb\"},\"inLanguage\":\"fr-FR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"fr-FR\",\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple#primaryimage\",\"url\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/wp-content\\\/uploads\\\/2023\\\/12\\\/De\u0301ploiement-dune-stack-comple\u0300te-de-test-automatise\u0301-avec-Squash.png\",\"contentUrl\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/wp-content\\\/uploads\\\/2023\\\/12\\\/De\u0301ploiement-dune-stack-comple\u0300te-de-test-automatise\u0301-avec-Squash.png\",\"width\":1105,\"height\":564},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/articles-techniques\\\/clean-code-par-lexemple#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Clean code par l\u2019exemple\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/\",\"name\":\"Blog Ouidou\",\"description\":\"Conseil et expertise en technologies\",\"publisher\":{\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"fr-FR\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/#organization\",\"name\":\"Ouidou\",\"url\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"fr-FR\",\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/wp-content\\\/uploads\\\/2022\\\/04\\\/image_2022-04-13_150237378.png\",\"contentUrl\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/wp-content\\\/uploads\\\/2022\\\/04\\\/image_2022-04-13_150237378.png\",\"width\":180,\"height\":180,\"caption\":\"Ouidou\"},\"image\":{\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/ouidou.fr\\\/blog\\\/#\\\/schema\\\/person\\\/e1d66085fb7c22ede319ce56adc373a4\",\"name\":\"Sara Lourties\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"fr-FR\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/b2ef32f9fc1e16168b39587a2ec1dafedc70a9d41fa1b4a930ec7744b3e35ec7?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/b2ef32f9fc1e16168b39587a2ec1dafedc70a9d41fa1b4a930ec7744b3e35ec7?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/b2ef32f9fc1e16168b39587a2ec1dafedc70a9d41fa1b4a930ec7744b3e35ec7?s=96&d=mm&r=g\",\"caption\":\"Sara Lourties\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Clean code par l\u2019exemple - Ouidou","description":"D\u00e9couvrez le clean code, une approche de programmation qui se concentre sur l\u2019\u00e9criture de code clair, lisible et facilement maintenable.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple","og_locale":"fr_FR","og_type":"article","og_title":"Clean code par l\u2019exemple - Ouidou","og_description":"D\u00e9couvrez le clean code, une approche de programmation qui se concentre sur l\u2019\u00e9criture de code clair, lisible et facilement maintenable.","og_url":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple","og_site_name":"Ouidou","article_published_time":"2023-12-07T09:05:20+00:00","article_modified_time":"2023-12-07T09:38:03+00:00","og_image":[{"width":1105,"height":564,"url":"https:\/\/ouidou.fr\/blog\/wp-content\/uploads\/2023\/12\/De\u0301ploiement-dune-stack-comple\u0300te-de-test-automatise\u0301-avec-Squash.png","type":"image\/png"}],"author":"Sara Lourties","twitter_card":"summary_large_image","twitter_misc":{"\u00c9crit par":"Sara Lourties","Dur\u00e9e de lecture estim\u00e9e":"11 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple#article","isPartOf":{"@id":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple"},"author":{"name":"Sara Lourties","@id":"https:\/\/ouidou.fr\/blog\/#\/schema\/person\/e1d66085fb7c22ede319ce56adc373a4"},"headline":"Clean code par l\u2019exemple","datePublished":"2023-12-07T09:05:20+00:00","dateModified":"2023-12-07T09:38:03+00:00","mainEntityOfPage":{"@id":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple"},"wordCount":2068,"publisher":{"@id":"https:\/\/ouidou.fr\/blog\/#organization"},"image":{"@id":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple#primaryimage"},"thumbnailUrl":"https:\/\/ouidou.fr\/blog\/wp-content\/uploads\/2023\/12\/De\u0301ploiement-dune-stack-comple\u0300te-de-test-automatise\u0301-avec-Squash.png","articleSection":["Articles Techniques"],"inLanguage":"fr-FR"},{"@type":"WebPage","@id":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple","url":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple","name":"Clean code par l\u2019exemple - Ouidou","isPartOf":{"@id":"https:\/\/ouidou.fr\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple#primaryimage"},"image":{"@id":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple#primaryimage"},"thumbnailUrl":"https:\/\/ouidou.fr\/blog\/wp-content\/uploads\/2023\/12\/De\u0301ploiement-dune-stack-comple\u0300te-de-test-automatise\u0301-avec-Squash.png","datePublished":"2023-12-07T09:05:20+00:00","dateModified":"2023-12-07T09:38:03+00:00","description":"D\u00e9couvrez le clean code, une approche de programmation qui se concentre sur l\u2019\u00e9criture de code clair, lisible et facilement maintenable.","breadcrumb":{"@id":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple#breadcrumb"},"inLanguage":"fr-FR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple"]}]},{"@type":"ImageObject","inLanguage":"fr-FR","@id":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple#primaryimage","url":"https:\/\/ouidou.fr\/blog\/wp-content\/uploads\/2023\/12\/De\u0301ploiement-dune-stack-comple\u0300te-de-test-automatise\u0301-avec-Squash.png","contentUrl":"https:\/\/ouidou.fr\/blog\/wp-content\/uploads\/2023\/12\/De\u0301ploiement-dune-stack-comple\u0300te-de-test-automatise\u0301-avec-Squash.png","width":1105,"height":564},{"@type":"BreadcrumbList","@id":"https:\/\/ouidou.fr\/blog\/articles-techniques\/clean-code-par-lexemple#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/ouidou.fr\/blog\/"},{"@type":"ListItem","position":2,"name":"Clean code par l\u2019exemple"}]},{"@type":"WebSite","@id":"https:\/\/ouidou.fr\/blog\/#website","url":"https:\/\/ouidou.fr\/blog\/","name":"Blog Ouidou","description":"Conseil et expertise en technologies","publisher":{"@id":"https:\/\/ouidou.fr\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/ouidou.fr\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"fr-FR"},{"@type":"Organization","@id":"https:\/\/ouidou.fr\/blog\/#organization","name":"Ouidou","url":"https:\/\/ouidou.fr\/blog\/","logo":{"@type":"ImageObject","inLanguage":"fr-FR","@id":"https:\/\/ouidou.fr\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/ouidou.fr\/blog\/wp-content\/uploads\/2022\/04\/image_2022-04-13_150237378.png","contentUrl":"https:\/\/ouidou.fr\/blog\/wp-content\/uploads\/2022\/04\/image_2022-04-13_150237378.png","width":180,"height":180,"caption":"Ouidou"},"image":{"@id":"https:\/\/ouidou.fr\/blog\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/ouidou.fr\/blog\/#\/schema\/person\/e1d66085fb7c22ede319ce56adc373a4","name":"Sara Lourties","image":{"@type":"ImageObject","inLanguage":"fr-FR","@id":"https:\/\/secure.gravatar.com\/avatar\/b2ef32f9fc1e16168b39587a2ec1dafedc70a9d41fa1b4a930ec7744b3e35ec7?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/b2ef32f9fc1e16168b39587a2ec1dafedc70a9d41fa1b4a930ec7744b3e35ec7?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/b2ef32f9fc1e16168b39587a2ec1dafedc70a9d41fa1b4a930ec7744b3e35ec7?s=96&d=mm&r=g","caption":"Sara Lourties"}}]}},"_links":{"self":[{"href":"https:\/\/ouidou.fr\/blog\/wp-json\/wp\/v2\/posts\/9630","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ouidou.fr\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ouidou.fr\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ouidou.fr\/blog\/wp-json\/wp\/v2\/users\/10"}],"replies":[{"embeddable":true,"href":"https:\/\/ouidou.fr\/blog\/wp-json\/wp\/v2\/comments?post=9630"}],"version-history":[{"count":8,"href":"https:\/\/ouidou.fr\/blog\/wp-json\/wp\/v2\/posts\/9630\/revisions"}],"predecessor-version":[{"id":11768,"href":"https:\/\/ouidou.fr\/blog\/wp-json\/wp\/v2\/posts\/9630\/revisions\/11768"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ouidou.fr\/blog\/wp-json\/wp\/v2\/media\/11764"}],"wp:attachment":[{"href":"https:\/\/ouidou.fr\/blog\/wp-json\/wp\/v2\/media?parent=9630"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ouidou.fr\/blog\/wp-json\/wp\/v2\/categories?post=9630"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ouidou.fr\/blog\/wp-json\/wp\/v2\/tags?post=9630"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}