L'une des choses les plus complexe pour un développeur est peut-être le nommage. Il est difficile de nommer un élèment de son code. De trouver le nom parfait qui saura décrire efficacement et simplement son intention. Et une fois ce nom trouvé, il sonne comme une évidence. L'intention découle aisément. On comprend tout de suite l'objectif de cet élèment. Le mauvais nommage peut avoir de lourdes conséquences sur la qualité d'un code, sa clarté et sa lisibilité peuvent mettre en dangé sa maintenabilité et sa capacité à évoluer dans le temps.

Dans cet article, nous aborderons également des bonnes pratiques pour bien nommer son code afin de faciliter sa compréhension.

Mise en situation

Avant d'aller plus en avant dans le sujet, prenons du recul pour comprendre les impacts et les risques d'un mauvais nommage dans votre code.

Prenons l'exemple d'un développeur d'un age assez avancé pour le qualifier d'expérimenté : Bugomatix, qui a la lourde tâche de récupérer un code legacy complexe de gestion de ressource humaines. Sa mission, en apparence assez simple, consiste simplement à ajouter une constante qui entre en jeu pour le calcul du bonus de fin d'année pour chaque département de son entreprise. Cette constante diffère naturellement en fonction du département.

En ouvrant naïvement le projet, il découvre un commentaire d'un certain Glitchoramix, à l'origine du code qu'il doit modifier.

Chaque département est représenté par un trigramme qui correspond à la première et la dernière lettre du département et d'un numéro entre 0 et 9 correspondant au nombre de lettre du-dit département. Si le nombre de lettre est supérieur à 9, alors on ne garde que le chiffre des unités.

Quelle ne fut pas la surprise de Bugomatix, lorsqu'il ouvrit le code et s'aperçu que l'ensemble des variables, des méthodes et mêmes des classes de ce code utilisait cette convention obscure de Glitchoramix. La tâche qui s'avérait assez simple en apparence, se montre finalement complexe de part la difficulté à prendre en main et comprendre le code existant.

Les risques d'un mauvais nommage

Un mauvais nommage dans le code peut avoir de nombreuses conséquences sur la productivité et la qualité du travail des développeurs. Lorsque les variables, les méthodes et les classes ne sont pas nommées de manière claire, il devient difficile de comprendre leur fonction, l'intention du code. On perd alors plus de temps à tenter de déchiffrer l'utilité de cet élèment mal nommé au travers du code, qu'à comprendre le code lui même. Cette obfusquation involontaire ou non du code peut aussi entrainer des bugs et des comportement innatendu.

De nos jours, avec les outils de développement modernes et les IDE performants dont nous disposons, il n'y a plus vraiment de raison d'utiliser des abréviations dans notre code. Ces outils permettent une autocomplétion rapide et intelligente des noms de variables, méthodes et classes, rendant les abréviations obsolètes. Il est donc préférable d'être explicite autant que possible pour simplifier la lecture du code et éviter les ambiguïtés.

N'oubliez pas que même vous, en tant que développeur, pourriez revenir sur votre propre code plusieurs mois après l'avoir écrit et avoir du mal à comprendre certaines parties si les noms sont trop cryptiques ou ambigus. Privilégiez toujours la clarté et l'expressivité dans votre nommage pour faciliter la compréhension et la maintenance du code, tant pour vous-même que pour vos collègues.

Nous écrivons du code pour les humains et non pour les machines. D'autant que nous passons beaucoup plus de temps à lire et à comprendre du code qu'à en produire.

Astuces

Heureusement, tout n'est pas perdu, en s'imposant quelques règles il est possible de s'éviter ces soucis.

Utiliser des noms descriptifs et précis

Choisissez des noms qui révèlent clairement l'intention et la fonction de la variable, de la méthode ou de la classe. Évitez les noms courts et ambigus qui pourraient prêter à confusion. N'ayez pas peur d'avoir des noms trop long s'ils permettent d'être plus explicite. Éviter donc les abréviations, les acronymes et autre convention de nommage obscure à la Glitchoramix.

Respecter les conventions de nommage

Suivez les conventions de nommage propres à votre langage de programmation, comme la camelCase pour les variables et les méthodes en JavaScript, ou la PascalCase pour les classes en C#.

Nommer les booléens de manière intelligente

Les noms des booléen doivent généralement être des adjectifs et indiquer clairement l'état qu'ils représentent (par exemple, isReady ou hasPermission).

Utiliser des noms spécifiques pour les collections

Lorsque vous travaillez avec des collections, utilisez des noms spécifiques qui indiquent le type de données qu'elles contiennent (par exemple, userList plutôt que list).

Éviter les noms trop génériques

Les noms trop génériques comme temp, data ou value rendent difficile la compréhension de l'intention du code.

N'hésitez pas à faire relire votre code au travers de Pair Review, voire même de coder en Pair Programming. Ces exercices vous permettront de challenger la lisibilité et la clarté de votre code.

Conclusion

Pour conclure, le nommage dans le code est un aspect essentiel pour garantir la lisibilité, la maintenabilité et la qualité d'un projet. Prendre le temps de choisir des noms clairs, cohérents et descriptifs permet non seulement de faciliter la compréhension du code, mais aussi de réduire le risque d'erreurs.