Dénomination des variables basée sur un code propre

Clean Code est l'ensemble de plusieurs conventions de code qui, ensemble, créent une nouvelle façon d'écrire votre code afin qu'il soit plus lisible, maintenable, fiable et prévisible, favorisant l'efficacité et facilitant le travail d'équipe. .

L'un des nombreux principes du code propre consiste à nommer les variables avec des noms auto-descriptifs et explicites pour éviter les ambiguïtés et écrire des codes plus propres, a déclaré un grand auteur Zeno Rocha dans son livre 14 habitudes de haute productivité Développeurs  nous devrions toujours écrire du code que notre futur moi pourra comprendre même après des années. Nommer des variables avec des diminutifs ou des abréviations peut conduire à des interprétations différentes, en particulier entre développeurs ayant différents niveaux d'implication dans le projet, cela peut conduire à des problèmes futurs.

Il est très courant qu'à mesure que la base de code s'agrandit et que sa variable est laissée de côté, il soit nécessaire de la revoir à l'avenir et une mauvaise écriture rendra difficile la compréhension de votre code qui vous aide.

exemples de mauvaises variables :

const date = new Date()
// Nome da varável é muito genêrica e não explica o que ela é

function getData(req, res) {}
// Nâo descreve bem o dado que ela está requisitando 

exemples de bonnes variables :

const currentDate = new Date()
// Nome mais explicativo sobre o que ela é e menos genêrico

function getUserGithubCategory(req, res) {} 
// Descreve melhor o dado que a função está requisitando 

Toujours dans cette même logique d'écriture de noms de variables significatifs, on arrive à un autre point important, qui serait lors de l'écriture de variables booléennes qui suivent le même sens d'écriture, mais il faut utiliser une autre petite règle qui s'accumule à la précédente.

Elle dit ce qui suit, nous devrions écrire les variables booléennes comme s'il s'agissait d'une sorte de question à laquelle on peut répondre par oui ou par non, car les variables booléennes ne peuvent recevoir que vrai (oui) ou faux (non) et une question dire s'ils sont actifs ou non aide à la lecture du code.

exemple sans appliquer la règle :

const ticketPark = user.ticketPark 

if (!ticketPark ) {
  throw new Error('O Marcos não possui um bilhete para entrar no parque!')
}

exemple avec application de la règle :

const hasUserTicket = user.hasTicket // o usuário tem o ticket ?

if (!hasUserTicket) { // se o usuário não tiver o ticket 
  throw new Error('O Marcos não possui um bilhete para entrar no parque!')
}

Êtes-vous d'accord avec moi qu'en utilisant ce modèle de dénomination des variables booléennes, cela ne simplifie pas la lecture en disant que si l'utilisateur a le ticket, il peut se rendre au manège plutôt que de simplement vérifier que le ticket du parc n'est pas faux? L'utilisation de ces types de éléments peut vraiment améliorer la compréhension de votre code par des tiers et vous aider également à éviter les ambiguïtés.

Enfin, nous avons juste une autre règle simple qui accompagne ces deux dernières, qui, en plus de mieux écrire votre code, est d'utiliser des variables pour stocker les « nombres magiques » dans votre code. Mais après tout, quels sont ces nombres magiques dans votre code ? Généralement, de nombreux programmeurs, lorsqu'ils appliquent des règles métier à leurs projets, utilisent divers nombres pour effectuer certaines opérations dans le code et qui à leur tour sont lancés dans le code sans nécessairement avoir aucune explication sur la raison pour laquelle ils sont là.

exemple de code rempli de nombres magiques :

const date = new Date()
// Nome da varável é muito genêrica e não explica o que ela é

Pouvez-vous comprendre à quoi sert le code ?

C'est difficile avec ces chiffres indescriptibles, non ?

avez-vous déjà entendu cette phrase « Je ne sais pas pourquoi autrement si vous supprimez le code » ? Cela représente bien ce que je veux dire ici, évitez de laisser ces nombres en vrac et sans expliquer pourquoi ils sont là, s'il n'est pas possible de le préciser dans une variable, faites un simple commentaire qui peut exister dans votre code.

Jetez un œil à la façon dont ce code doit être écrit :

function getData(req, res) {}
// Nâo descreve bem o dado que ela está requisitando 

C'est mieux maintenant, non ?

Avantages

Adopter des pratiques telles que nommer clairement les variables, éviter les nombres magiques et suivre les principes du Clean Code améliore non seulement la qualité de votre code, mais facilite également la collaboration avec d'autres développeurs et sa maintenance à long terme.

Rappelez-vous : écrire du code propre ne consiste pas à atteindre la perfection, il s'agit de rendre le code plus accessible, compréhensible et prévisible pour tous ceux qui l'utilisent, y compris vous à l'avenir.

Essayez d'appliquer ces règles à votre prochain projet et remarquez la différence ! Partagez ces conseils avec vos collègues ou votre équipe pour créer un environnement de travail plus productif et efficace. Après tout, un code bien écrit est la première étape pour créer un logiciel de haute qualité.

Alors, que diriez-vous de commencer aujourd'hui ? Écrivez du code que vous serez fier de lire à l'avenir !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!