Nommage

La première discipline permettant d’obtenir un Clean Code se caractérise par la manière dont vous allez nommer l’ensemble de ce que contient votre code : variables, constantes, classes, objets, fonctions, etc…

La grande difficulté de cette tâche est qu’elle comporte de nombreuses règles, et qu’il n’existe aucune solution toute faite. Vous devrez chercher dans votre imagination et dans votre connaissance du langage afin de trouver les termes adéquats. Malgré tout, voici quelques règles qui pourront vous permettre de réussir dans cette première étape :

• Choisissez une langue, et n’en changez pas ! Majoritairement, les développeurs utilisent l’anglais dans l’ensemble de leur code, y compris de leurs commentaires. Si vous n’êtes absolument pas à l’aise avec l’anglais, le premier compromis est d’utiliser un traducteur en ligne. Le second compromis est de coder en français, mais cela risque d’engendrer de nombreuses difficultés pour la suite (notamment lorsque vous serez amené à intervenir sur un code réalisé par quelqu’un d’autre en anglais).
• Utilisez des noms explicites, même s’ils doivent être longs pour cela. L’important étant qu’ils soient clairs quant à vos intentions et à leurs significations.
• N’utilisez JAMAIS d’acronymes. “MOQ” sera toujours moins évident que “MinimumOrderQuantity”, d’autant plus lorsque vous n’êtes pas familier avec un langage métier spécifique.
• Évitez les noms trop courts. La majorité des conventions existantes au sein des différents langages de programmation s’accordent sur le fait que 3 seraient le nombre de caractères minimum requis pour une variable. Aussi évitez tous les noms de variables faisant moins de 3 caractères.
• Priorisez les termes informatiques. Si aucun terme informatique ne vous permet de définir correctement le nom de votre variable, orientez-vous alors vers un terme spécifique au domaine de votre solution. Enfin si vous ne trouvez toujours pas de nom correct, focalisez-vous sur l’utilisation de mots simples et explicites.
• Il existe également d’autres facteurs à prendre en compte, qui sont propres au contexte dans lequel vous vous trouvez :
  • Utilisez les conventions de nommage du projet en cours. Si vous êtes amené à intervenir sur un projet, et que celui-ci ne respecte pas vos conventions de nommage, il est important que vous sachiez vous y adapter.
  • Utilisez les mêmes mots tout au long d’un projet. Si votre projet est constitué de 15 applications, et que chacune d’entre elles doit interagir avec une entité “utilisateur” par exemple, appelez là “User” dans toutes les applications.
• Voici enfin quelques astuces pouvant vous permettre de faciliter la gestion de votre nommage :
  • Utilisez des mots prononçables. Si les choix que vous faites ne sont pas prononçables, c’est probablement que le terme utilisé n’est pas adapté !
  • Évitez la désinformation. Appelez un chat un chat, et un chien un chien. Ne créez pas une variable NombreMagique si celle-ci doit contenir le prénom d’un utilisateur !
  • Ne faites pas de codification. Il est inutile de préfixer chaque tableau (Array) de la lettre “A”. Si au premier abord cela peut vous permettre de comprendre qu’une variable contient un tableau, qu’en sera-t-il pour une variable qui contiendra un objet ? une chaîne de caractères ? un nombre ? Si vous vous engagez dans cette logique, vous risquez de vous y perdre, d’autant plus qu’aujourd’hui le typage est un indicateur fort et certain quant au contenu d’une variable.
  • Évitez les blagues ! Chaque personne à son propre sens de l’humour, et sa compréhension des mots… J’avais pour habitude en CSS de créer une classe “titanic”, à laquelle j’appliquais la valeur “float: none;”. Si sur le fond ce nommage vous fait rire vous aussi, il n’en reste cependant pas suffisamment explicite pour le trouver facilement et le réexploiter par la suite. Il y a donc de fortes probabilités pour qu’une personne n’étant pas habituée à ce genre de nommage fasse un duplicata de ce code sans même s’en rendre compte. Notez ici que ce ne sera pas la faute de la personne en question, mais bien la mienne !

L’ensemble de ces pratiques devrait vous permettre de réussir à nommer correctement l’ensemble de votre code. Attention à un détail important, qui n’est jamais trop répété : lorsque vous écrivez du code en anglais, et qu’en tant que développeur consciencieux vous choisissez de commenter votre code, pensez également à le rédiger en anglais ! Les commentaires ne sont pas exemptés de respecter les conventions de nommage ou d’écriture.