Kalicrunch la newsletter, je m'abonne
Actualités
bonnes pratiques code proptre
Expertise

Code propre ? Les 3 principes incontournables.

14 octobre 2020

Le saviez-vous ? Un code passe la plus grande partie de sa vie à être lu, c’est pourquoi son écriture est essentielle.

Quel que soit le langage de programmation, avoir un code propre est un principe fondamental de l’ingénierie pourtant le code est trop souvent mal écrit, mal lu, mal compris. C’est souvent le résultat de mauvaises habitudes ou de mauvaises pratiques de développeurs pourtant bien intentionnés. Résultats ? Votre développement logiciel est instable et enchaine les dysfonctionnements. Une fois produite, votre application sera difficile à maintenir et à faire évoluer. Elle consommera plus de ressources que prévu, humaines comme financières.

À quelles caractéristiques reconnait-on un code propre ?

  • Un code propre est un code qui a été réfléchi pour être compréhensible et lisible par tous ceux qui seront amenés à le « consommer » : autres développeurs, chef du projet, la prochaine personne qui interviendra, etc.
  • Un code propre est un code fonctionnel qui a été testé car même s’il est de qualité aujourd’hui, rien de garanti qu’il ne se casse pas du tard ou qu’il rencontre des défaillances. Conserver les tests permet aussi de sauvegarder votre code et de le remanier sans le compromettre.
  • Un code propre, c’est une pratique qui s’entretient. C’est comme un instrument de musique, s’il veut conserver ses compétences en codage, le développeur doit pratiquer régulièrement. Donc, même si vous avez envie de coder par plaisir pour un projet personnel que personne d’autres que vous ne verra jamais, codez propre !
  • Un code propre doit être flexible, maintenable et durable. Il doit être immédiatement compréhensible, lisible et modifiable par des tiers.
  • Une code propre peut s’appuyer sur les principes du S.O.L.I.D

Clean Code, les trois principes de base

  1. Le code parfait n’existe pas mais il doit bien être bien conçu (Craftmanship*). Contrainte financière, externalisation auprès de tiers, time-to-market ; on a rarement le temps et les moyens de peaufiner chaque ligne de code pour qu’elle soit parfaite. Il est rare également que tout code soit exempt de bug du premier coup. Cependant, un bon développeur doit mettre à profit ses compétences pour tendre vers le « bon code », il a la main sur la qualité de ce qu’il produit. Certes, l’objectif est évidemment de répondre aux besoins exprimés dans le cahier des charges en fournissant un code « fonctionnel » mais cela ne suffit pas, il doit être bien fait, efficace et utile. Car si sa seule vocation est de répondre à des problématiques à court terme, un code mal conçu n’aboutira jamais à de bons résultats à moyen terme. Une application avec un code de mauvaise qualité sera difficilement débuggable et quasiment impossible à maintenir et à faire évoluer dans le temps.
  2. Ce qui est fait n’est plus à faire. Autrement dit, l’effort de conception et la petite perte de temps passés à produire un code propre seront largement rentabilisés, et bien plus rapidement qu’on ne le pense. Toute qualité injectée dans le code participe à sa longévité, son usabilité et sa maintenabilité dans le temps. Comme en beaucoup de choses, il vaut mieux parfois payer un peu plus cher un objet de qualité et le conserver longtemps ; que de chercher à faire une affaire sur une « contrefaçon » qui sera jetable et qu’il faudra racheter. Un code de qualité, produit méticuleusement et testé, est une source d’économies à moyen terme et réduit la dette technologique. « Petit » est également une règle incontournable. Les gros blocs de code de centaines de lignes sont à bannir, ils sont toujours illisibles et beaucoup trop complexes. Vous devez les remanier dans une longueur acceptable. Il en est de même pour les fonctions et les méthodes. Une fonction ne devrait pas comporter plus de 20 lignes et horizontalement, chaque ligne pas plus de 80 caractères.
  3. Votre code ne vous appartient pas ! Tout bon développeur est fier de son travail… mais il doit néanmoins avoir conscience que le code qu’il est en train d’écrire n’est pas le sien ! Il est destiné à être vu, lu, remanié et consommé par d’autres. Il doit être écrit pour être compris. Nul ne doit avoir besoin de le déchiffrer. Ainsi, si vous éprouvez le besoin d’expliquer votre code avec du texte, c’est que vous pouvez encore l’améliorer. Les commentaires doivent être utilisés uniquement pour expliquer des règles particulières, un bon code se passe de commentaires. Il est également important de nommer de manière explicite vos variables, fonctions ou classes afin que l’on comprenne de quoi il s’agit et l’usage qui en est fait.

Sources :

À lire également
Actualité Flash
28 octobre 2020
JavaScript reste le langage de programmation le plus populaire parmi développeurs du monde entier ! Souvent, et chez Kalisoft en particulier, les développeurs maîtrisent parfaitement plusieurs langages pour pouvoir intervenir sur différents projets comme Python, Java – respectivement en 2ème et 3ème langages les plus utilisés – C/C++, PHP, et C# … mais aussi des(...)
Actualité Flash
6 octobre 2020
Il était temps pour nous de changer de nom pour mieux incarner notre identité, ce que nous sommes devenus et illustrer la valeur ajoutée pour laquelle nous sommes reconnus. Dima Consulting change de nom et devient Kalisoft : Kali pour la qualité logicielle (QA) et Soft pour le développement. Kalisoft s’engage sur la qualité des applications et des solutions délivrées dans une logique de test driven developement. La démarche Kalisoft « Code propre, 0 défaut, 0 dette technologique » s’emploie à garantir la qualité des actifs logiciels dans le temps pour une technologie plus durable, maintenable et évolutive.
Actualité Expertise
3 septembre 2020
Par Lahossaine El Khaloui, Directeur Régional Haut-de-France et Tests Tech Leader, Kalisoft Le time to market vous impose de livrer toujours plus rapidement de nouvelles applications ou de nouvelles fonctionnalités. Et aujourd’hui, plus que jamais, vous n’avez pas le droit à l’erreur. La qualité délivrée doit être irréprochable et l’expérience client sans aucune faille. Chez Kalisoft,(...)