Share
Sur ce site, nous passons beaucoup de temps à partager des informations et à discuter de la manière d'accomplir certaines choses avec WordPress. Après tout, le but du site est pour fournir des tutoriels - c'est-à-dire que nous essayons de donner des conseils pratiques sur la manière de construire certaines choses en utilisant la plateforme.
Mais le développement ne consiste pas uniquement à écrire du code et à construire des choses. Il s'agit également d'écrire de la qualité, du code maintenable, de refactoriser et d'améliorer l'état de nos projets, et d'essayer en général de laisser une base de code dans un meilleur état que lorsque nous l'avons trouvé (ou lorsque nous avons commencé à le créer)..
Donc, plutôt que de vous concentrer sur la manière de construire quelque chose ou de réviser un code particulier, passons en revue quelques conseils pratiques pour rédiger du code WordPress de qualité.
D'abord et avant tout - et même si nous en discutons beaucoup -, cela vaut la peine de le répéter encore et encore:
Suivre les normes de codage WordPress est l’une des choses les plus importantes que vous puissiez faire lorsque vous écrivez vos thèmes, plug-ins ou applications..
Pour ceux qui ne sont pas familiers, les normes de codage WordPress fournissent des règles sur la manière dont nous devrions formater notre PHP basé sur WordPress. Bien sûr, il n'y a rien à réellement imposer les règles - vous pouvez les ignorer (et beaucoup le font), mais c'est considéré comme une bonne pratique pour ceux qui sont sérieux au sujet du développement de projets WordPress, et il est respecté par ceux qui sont actifs dans la communauté..
De plus, le respect des normes de codage signifie que nous - avec tous les autres développeurs qui le font également - aurons un code similaire. En fait, l’un des objectifs des normes de codage définies est que le code donne l’impression qu’il a été écrit par un seul développeur..
Un autre avantage est que cela facilite également la contribution de tiers à notre base de code. Après tout, étant donné que WordPress et ses travaux dérivés sont des sources ouvertes, d’autres voudront peut-être se joindre à nous ou apporter leur contribution, ce qui leur donnera la possibilité de lire facilement notre code..
Enfin, ce n'est pas nécessairement un appel à l'action pour revenir en arrière et reformuler tout ce que vous avez fait. Le moment est venu de commencer à suivre les normes. Les bons développeurs s'améliorent constamment, il est donc parfaitement acceptable de commencer maintenant (même si c'est au milieu d'un projet).
Une des choses les plus utiles que vous puissiez faire lorsque vous écrivez du code est de laisser des commentaires utiles qui expliquent exactement ce que vous essayez de faire..
Naturellement, les commentaires peuvent vivre au niveau de la classe, au niveau de la fonction et au niveau de la ligne. Ils sont autorisés en PHP, HTML, JavaScript et CSS, il n'y a donc aucune excuse ne pas les inclure quelque part.
Bien sûr, écrire des commentaires prend un peu plus de temps, mais rappelez-vous que s'il était facile à lire, cela ne s'appellerait pas du code.
Pensez-y de cette façon: les programmeurs ont la réputation de revenir à leurs projets précédents et de reconnaître à quel point leur code est mauvais, ou comment nous ferions quelque chose de différent si nous travaillions sur ce projet maintenant..
Si nous disons cela à propos de notre propre code, que doivent penser les autres quand ils voient notre code, en particulier s'ils viennent d'un milieu plus expérimenté??
Pour plus de détails sur les commentaires à la fois sur les codes côté serveur et côté client, veillez à consulter cette série..
Une autre chose que nous, développeurs, pouvons faire est de simplifier nos fonctions. Bien que je réalise qu’il s’agit d’un domaine quelque peu subjectif, je pense que le fait de viser des fonctions plus petites et plus ciblées rend le code plus lisible et peut en fin de compte faciliter la testabilité (si vous êtes intéressé par cette voie)..
Premièrement, il n’est pas rare de voir des fonctions qui dépassent 30, 40 ou 50 lignes. Le problème est que ces fonctions font souvent plus d'une chose.
C'est problématique parce que:
Cela dit, nous pouvons suivre quelques conseils pratiques pour améliorer la qualité de nos fonctions..
Si vous vous retrouvez à écrire la même chose à plusieurs reprises entre différentes fonctions, vous devez alors extraire cette partie du code et la déplacer vers sa propre fonction afin qu'elle puisse être appelée par tous les emplacements il existe actuellement.
Si vous trouvez que votre code est soit compliqué à décrire avec des commentaires, soit difficile à tracer tout en le lisant, il peut être utile de prendre du recul et de refactoriser votre code en quelque chose de plus simple..
Cela semble différent dans chaque situation, mais rechercher la lisibilité plutôt que la complexité est souvent un meilleur objectif à atteindre que de simplement obtenir quelque chose qui fonctionne..
C’est sans doute le point le plus subjectif, je pense que cela vaut la peine d’être soulevé et c’est tout simplement que nous devrions nous efforcer de garder nos fonctions réduites, avec 20 lignes de long étant une longueur relativement solide à viser. Bien sûr, cela peut être un peu un défi avec la façon dont WordPress nous oblige souvent à créer de grands tableaux à passer comme arguments, mais vous avez l’idée: gardez-les petits, concentrés et maintenables..
Oui, cela se traduira par plus de fonctions, mais le code sera plus facile à lire et à gérer car chaque fonction a un seul but spécifique. Cela signifie que vous pouvez les nommer avec une plus grande clarté et fournir plus facilement des tests unitaires autour d'eux..
Bien entendu, aucune des règles ci-dessus n’est une règle stricte à suivre. Il s’agit simplement de suggestions pour améliorer la qualité du code que nous écrivons, maintenons et que nous contribuons au travail des autres..
Par-dessus tout, je pense que nous devrions nous efforcer d'obtenir une lisibilité et une testabilité. Garder ces deux objectifs au premier plan de notre travail contribuera à placer tout le reste à sa juste place.
Bien sûr, ce n'est pas une liste complète - c'est loin d'être le cas! Alors s'il vous plaît offrir vos suggestions dans les commentaires!
Accentsconagua