Code propre: conseils pour devenir un meilleur développeur WordPress (2)
Et des études de cas qui aident à déterminer quand et comment améliorer les fragments. En d’autres termes, c’est une base de connaissances qui décrit comment écrire, lire et nettoyer le Code.
Si vous lisez attentivement le livre et essayez d’apprendre toutes les leçons qu’il contient, vous finirez par comprendre comment faire la distinction entre le bon et le mauvais Code comment écrire le bon Code et comment convertir le Code d’erreur en Code valide De bons objets et de bonnes classes Comment formater le Code pour une lisibilité maximale comment mettre en œuvre une gestion complète des erreurs sans brouiller la logique du Code comment tester les lecteurs et pratiquer le développement basé sur les tests est très bon, n’est – ce pas? Le livre est divisé en chapitres: code propre. Décrit la différence entre le Code incompréhensible et le code propre. Je trouve l’image au début de ce chapitre très intéressante, qui décrit clairement le contenu du livre:
Comment ajouter efficacement la gestion des erreurs à votre code. Essentiellement, il couvre une réalité tragique: la gestion des erreurs est une pièce jointe dont nous avons besoin, mais elle peut ne pas être liée à la fonctionnalité principale de notre logiciel. Par conséquent, son ajout au Code rend le Code « sale » et inutilement complexe. Ce chapitre vous montre comment le faire proprement. Bordure. L’un des problèmes les plus difficiles pour les programmeurs (en particulier dans WordPress) est notre dépendance vis – à – vis des bibliothèques ou des services externes: s’ils changent, les choses peuvent cesser de fonctionner. Ce chapitre identifie plusieurs situations dans lesquelles il peut y avoir des problèmes de compatibilité lorsqu’on s’appuie sur des solutions tierces et explique comment éliminer ou minimiser leurs effets. Tests unitaires. Il n’y a pas grand – chose à dire dans ce chapitre: Nous en avons discuté en profondeur dans les articles précédents. Cours. Dans le premier chapitre, ce livre couvre les éléments constitutifs du codage: fonctions, structures de données, variables, etc. Comme le code propre exige une bonne organisation, plusieurs chapitres sont consacrés à ce sujet. Dans ce chapitre, il met l’accent sur les concepts de Programmation orientée objet et de ses classes et donne quelques conseils de base sur les dimensions et les responsabilités. Le système. Ce chapitre est plus abstrait que le précédent car il explique le concept de \
Commentaires, pour les synchroniser avec les commentaires… C’est un travail supplémentaire! D’autre part, les commentaires peuvent finir par être désagréables.
Par exemple, considérez le fragment suivant: \/ \/ Vérifiez si l’employé a droit à tous les avantages sociaux
N’est – ce pas mieux si ((employee.flags & hourly _ Flag) & & (employee.age > 65))? Si (employee.is eligibleforfullbenefits ()), vous pouvez expliquer la plupart des intentions dans votre code en quelques secondes. Dans de nombreux cas, il s’agit de créer une fonction avec le même nom que votre commentaire représente. C’est ainsi que vous pouvez rendre votre code plus propre et meilleur. Disclaimer Parfois, vous devez annoter votre code. Par exemple, si vous créez une API, il est clair qu’elle doit être bien documentée afin que vos utilisateurs puissent l’utiliser efficacement, après tout, ils peuvent ne pas connaître son intérieur. Dans tous les cas, cependant, les noms des fonctions et des arguments doivent être aussi clairs que possible.
Quoi? Argent \
Non seulement les variables globales provoquent des effets secondaires inattendus, mais elles produisent également des paramètres dans la fonction! Lorsque cela se produit, la valeur d’un ou plusieurs paramètres change après l’appel de la fonction, ce qui est évidemment un comportement inattendu. En général, nous supposons que le paramètre de la fonction est
Saisissez seulement les variables. La seule façon de savoir qu’une variable change lorsqu’elle est utilisée comme argument de fonction est par sa documentation, et nous voyons juste que les commentaires ne devraient pas être nécessaires, n’est – ce pas? Pour bien comprendre le problème, consultez l’exemple suivant:
Classe commune uservalidator {
Je…
Mot de passe booléen commun (nom d’utilisateur de la chaîne, mot de passe de la chaîne)
Utilisateur = passerelle utilisateur. Findbyname (nom d’utilisateur);
Si (user! = user.null)
Si (user.haspassword)
Un seul. Initialisation ();
Renvoie True;
}
}
Renvoie False;
}
Je…
Pouvez – vous détecter des effets secondaires? Exactement. L’effet secondaire est d’appeler la session. Initialisation (). L’utilisateur appelle une fonction qui devrait évidemment vérifier le mot de passe, donc l’utilisateur veut que la fonction fasse ce qu’elle dit. Alors, pourquoi initialiser la session?? Personne ne sait! Si c’est le comportement que nous voulons, il est préférable d’utiliser un autre nom: checkpassword et initializesession
Quoi? Kim. \
Il a utilisé des noms destinés à être exposés. Combien de fois avez – vous trouvé une variable nommée d suivie d’un commentaire expliquant ce qu’elle est? Parfois, les programmeurs sont paresseux… On ne devrait pas.
Cello! Utilisez un nom différent, comme un fichier elapsedtimeindays, daysincecreation ou ageindays. Le vrai nom n’a pas d’importance tant qu’il est clair et significatif. Évitez les messages d’erreur. Les noms doivent fournir des renseignements véridiques et ne doivent pas mentir. Par exemple, si nous avons un ensemble de comptes, ne nommez pas la variable accountlist, qui indique au programmeur qu’elle est implémentée comme une liste et peut – être pas. Un meilleur nom serait un compte. Faites une différence significative. Parfois, en raison des contraintes linguistiques, nous ne pouvons pas nommer une chose par le mot que nous voulons. Par exemple, si nous voulons nommer une variable class, nous ne pouvons pas parce que c’est un mot – clé secret. Pour surmonter ce problème, nous avons tendance à mal épeler le mot et à le remplacer par Klass ou classz. C’est une mauvaise idée. Dans ces cas, nous devrions utiliser des synonymes ou autre chose. Un autre exemple courant est que nous avons deux variables du même type que nous les nommons de la même façon et ajoutons un nombre à la fin: string1 et string2. N’est – ce pas mieux si nous appelons cela la source et la destination? Voyez à quel point il est facile de deviner ce qu’ils feront une fois que les noms auront été correctement définis! Utilisez un nom qui peut être prononcé. L’exemple dans le livre est hilarant: une entreprise a une variable appelée genymdhms (date de génération, année, mois, jour, heure, minute et seconde), de sorte que ses employés disent \
Wings Il n’est pas surprenant qu’il y ait beaucoup de ces règles dans WordPress: have _ posts, get the author, ou Is Single. Choisissez un mot pour chaque concept. Parfois, le même concept peut être exprimé par différents synonymes: Fetch, get ou retrieve; Supprimer, supprimer ou jeter. Dans ce cas, vous devriez toujours essayer d’utiliser le même concept. Cela facilitera la compréhension de votre code et réduira votre fardeau mental. Il y en a plein d’autres! En bref, clean Code est un livre intéressant et instructif. Je vous recommande de l’acheter maintenant et de l’ajouter à votre bibliothèque personnelle. Il contient des conseils et des astuces très utiles. Croyez – moi, le saut qualitatif entre le code écrit avant et après la lecture de ce livre est énorme. Tu l’as lu? Qu’en penses – tu? Avez – vous d’autres suggestions? Photos de Joel Filipe prises par unsplash.