Lorsque vous commencez à apprendre à coder, votre objectif principal est d’écrire du code qui fonctionne correctement pour le problème que vous résolvez. Oui, le code doit fonctionner correctement et c’est un bon endroit pour commencer à apprendre. Cependant, dans un environnement de travail réel, vous voulez également vous assurer d’écrire du code propre.
Un code propre est lisible, extensible, modifiable et maintenable. Ce sont toutes des qualités importantes pour un code.
Dans de nombreux contextes professionnels, vous n’écrivez pas de code de manière totalement isolée. Il y a d’autres personnes avec qui vous travaillez dans une équipe. Vos coéquipiers doivent être capables de comprendre facilement le code que vous écrivez. Ils doivent comprendre ce qu’il fait, comment il fonctionne et pourquoi il a été écrit de cette façon. Il se peut également que votre futur moi revienne au code que vous avez écrit dans le passé et vous devrez également comprendre facilement votre code.
Le code est lu plus qu’il n’est écrit. Pour écrire du code, nous le lisons constamment. Donc, même si un code lisible est plus difficile à écrire, nous devrions investir du temps pour le faire au lieu d’écrire du code illisible facile. Écrire du code propre est une compétence importante pour tout développeur professionnel.
Dans cet article, vous allez découvrir l’importance de Appellation en écrivant du code propre.
Nommer est une tâche cruciale et quotidienne pour les développeurs dans n’importe quel langage de programmation. Cela peut rendre le code très difficile à comprendre ou, s’il est bien fait, facile à comprendre.
Les noms sont partout écrits par les développeurs de logiciels. Lors du codage, vous devez envisager de nommer les variables, les fonctions, les arguments, les classes, les packages, les fichiers source et les répertoires qui contiennent ces fichiers source, etc.
Vous trouverez ci-dessous quelques citations populaires sur le nommage dans la programmation.
« Il n’y a que deux choses difficiles en informatique : l’invalidation du cache et le nommage des choses. » – Phil Karlton
« N’importe quel imbécile peut écrire du code qu’un ordinateur peut comprendre. Les bons programmeurs écrivent du code que les humains peuvent comprendre » — Martin Fowler
Les noms sont le plus petit bloc de construction du code. Les noms sont le bloc de construction de base du code propre. Il existe quelques règles recommandées pour un bon nommage dans le code. Discutons de ces règles pour le reste de cet article.
Utiliser des noms révélateurs d’intention
Les noms que vous utilisez dans votre code doivent être clairs et compréhensibles. Choisissez des noms descriptifs et sans ambiguïté. Vous devez vous concentrer sur le principe de moindre surprise. Essayez d’écrire du code auquel les autres s’attendraient et essayez de ne pas les surprendre avec des complexités astucieuses.
Le nom d’une variable, d’une fonction ou d’une classe devrait répondre à toutes les grandes questions. Il devrait vous dire pourquoi il existe, ce qu’il fait et comment il est utilisé. Si un nom nécessite un commentaire, alors le nom n’est pas révélateur d’intention.
Vous trouverez ci-dessous un exemple de code qui n’est pas révélateur d’intention et qui nécessite un commentaire de description et une version plus propre avec un meilleur nom qui ne nécessite pas de commentaire de description.
let rf = 5000 //the rental fee paid by the tenant
utilisez la version plus propre ci-dessous
let rentalFee = 5000
Les classes et les objets doivent avoir des noms ou des expressions nominales
Les classes et les objets décrivent des choses de sorte que leurs noms dans le code doivent être un nom ou une phrase nominale. Les noms tels que Utilisateur, Étudiant, Compte et ErrorLogger sont de bons noms pour les classes et les objets. Évitez les mots comme Manager, Processor, Data ou Info dans le nom d’une classe. Un nom de classe ne doit pas être un verbe.
Les méthodes/fonctions doivent avoir des noms de verbe ou d’expression verbale
Les méthodes/fonctions effectuent une action dans le code de sorte que leurs noms doivent être un verbe ou une phrase verbale. Des noms tels que deleteApplication, createUser, ou save sont de bons noms pour les méthodes/fonctions. De par sa conception, une fonction ne devrait avoir qu’une seule responsabilité. Si le nom est autre chose qu’un verbe, alors soit vous le nommez mal, soit il y a des problèmes dans l’architecture.
Faites des distinctions significatives
Vous devriez essayer d’utiliser le même mot dans le même but dans toute la base de code. Évitez d’utiliser des mots différents mais similaires pour définir les mêmes concepts. Les trois appels de méthode/fonction ci-dessous pourraient signifier la même chose à titre d’exemple.
FetchResult() vs GetResult() vs RetrieveResult().
Par exemple, n’utilisez pas fetch, get et retrieve dans le même projet pour la même responsabilité.
Utilisez des noms prononçables et consultables
Lorsque vous nommez des éléments dans votre code, utilisez des mots qui peuvent être prononcés plutôt que des mots non prononçables.
Vous trouverez ci-dessous un exemple de nom de variable difficilement prononçable et une version plus claire avec un nom plus prononçable.
Date modymdhms;
utilisez la version plus propre ci-dessous
Date modificationTimestamp;
Remplacer les nombres magiques par des constantes nommées
Lorsque vous utilisez des valeurs constantes, définissez-les à l’aide de mots pouvant être recherchés. Cela les rend plus compréhensibles pour les autres développeurs.
Au lieu d’écrire du code comme celui-ci :
let totalLoanDays = gracePeriod + 7;
créez une constante nommée et utilisez-la comme ceci :
const NUMBER_OF_DAYS_IN_WEEK = 7;
let totalLoanDays = gracePeriod + NUMBER_OF_DAYS_IN_WEEK;
Ne pas ajouter d’informations de type
Lorsque vous nommez vos variables, évitez de leur ajouter des informations de type. Le nom de la variable doit indiquer clairement les données qu’elle stocke et les développeurs peuvent en déduire le type. Il n’est pas nécessaire de mentionner le type de données dans le nom.
Au lieu d’écrire du code comme celui-ci :
let firstNameString;
let lastNameString;
utilisez la version plus propre ci-dessous
let firstName;
let lastName;
Ne soyez pas offensant / Ne soyez pas un comédien
Restez professionnel dans la façon dont vous nommez les choses dans votre code. Ne soyez pas offensant ou n’essayez pas d’être un comédien en donnant à une variable un nom amusant. N’oubliez pas que vous écrivez du code de production que d’autres futurs développeurs de logiciels devront comprendre facilement. Vos conventions de nommage doivent être génériques et ne doivent inclure aucun argot culturel.
Évitez d’écrire du code comme celui-ci :
function killThemAll();
utilisez la version plus propre et professionnelle ci-dessous
function deleteAllUsers();
Pensées de clôture
Dans cet article, nous avons exploré certaines des meilleures pratiques pour nommer des éléments dans votre code et certaines choses que vous devriez éviter de faire. Nommer peut sembler une petite partie du travail d’un développeur de logiciels, mais c’est très important et peut être la principale différence entre avoir une base de code propre avec laquelle il est agréable de travailler ou une base de code complexe difficile à comprendre et à naviguer.
« Une différence entre un programmeur intelligent et un programmeur professionnel est que le professionnel comprend que la clarté est reine. Les professionnels utilisent leurs pouvoirs pour de bon et écrivent du code que les autres peuvent comprendre. » – Clean Code: A Handbook of Agile Software Craftsmanship par Robert C Martin.
Vous ne devez jamais ignorer l’importance des pratiques de nommage dans votre base de code, car les mauvais noms deviendront un gros obstacle dans les futurs plans de développement. Changer la base de code à ce stade est une surcharge inutile et peut être évité au tout début en suivant les bonnes pratiques.