Share
Le but de cette série est d’exposer les normes de codage WordPress, leur importance et la façon d’écrire du code WordPress de qualité. Pour ce faire, nous examinons en détail chaque section des normes de codage WordPress..
Jusqu'à présent, nous avons couvert:
Aujourd'hui, nous allons couvrir l'importance de l'espace blanc. Plus précisément, nous allons couvrir l’indentation, l’utilisation de l’espace et les espaces de fin. Aussi facile que cela puisse paraître, ce sont plusieurs des aspects les plus ignorés ou les plus mal utilisés des normes de codage..
Avant d'examiner ce qui se passe avec les différentes normes de codage, il est important de comprendre pourquoi l'espace blanc est important non seulement dans WordPress, mais dans les langages de programmation en général..
En termes simples, c'est parce que cela améliore la lisibilité.
C'est pourquoi certains langages de programmation sont délimités par des espaces ou des tabulations. C'est pourquoi certains langages de programmation vous demandent d'espacer certaines parties du code, telles que les paramètres de fonction, les index de tableaux, etc..
En ce qui concerne WordPress, les conventions sont en place non seulement pour la lisibilité, mais également pour offrir une expérience de lecture et de développement cohérente à tous ceux qui travaillent sur des thèmes, des plugins, des applications ou l'application principale elle-même de WordPress..
Rappelles toi: Le but des normes de codage est de faire en sorte que le code source ait l’impression qu’il ait été écrit par un seul développeur car il définit un niveau d’attentes pour les développeurs contributeurs..
En ce qui concerne l'indentation, il n'y a rien de particulièrement nouveau, révolutionnaire ou différent en ce qui concerne WordPress. En règle générale, vous indenter chaque fois que vous démarrez un nouveau bloc.
Cela signifie que:
Si vous avez l'habitude d'écrire du code dans des langages de style C, rien de particulièrement nouveau ici, à droite?
Voici un exemple de ce à quoi cela pourrait ressembler:
fonction foo ($ arguments) if (0 < count( $arguments ) foreach ( $arguments as $arg => $ valeur) echo $ valeur;
Selon les normes de codage:
Votre mise en retrait doit toujours refléter la structure logique. Utilisation vrais onglets et pas d'espaces, car cela permet le plus de flexibilité entre les clients.
Les points clés sont que le début des lignes doit commencer par des tabulations et que le code doit refléter une logique structure. Ne pas trop compliquer ou essayer de simplifier à l'excès.
Les normes de codage WordPress présentent une autre nuance dans les espaces: les tabulations doivent être utilisées au début de la ligne, mais les espaces doivent être utilisées partout ailleurs. Pour l’essentiel, c’est une règle facile à suivre; cependant, dans WordPress, vous allez souvent créer des tableaux à passer comme arguments.
Idéalement, nous voulons aligner chaque index du tableau de manière à ce que la lisibilité soit aussi grande que possible, mais nous avons souvent tendance à utiliser des tabulations pour faciliter leur alignement, mais cela constitue en réalité une violation des normes de codage..
Accentsconagua
$ args = array ('ID' => 1, 'post_title' => 'Le titre', 'post_content' => 'Le contenu'); En tant que tel, assurez-vous que vous seulement utiliser des tabulations au début de chaque ligne.
En ce qui concerne WordPress, j'ai constaté que les espaces ont été utilisés beaucoup plus libéralement que dans d'autres langues. Je ne dis pas cela simplement comme une observation, car c’était un ajustement personnel que je devais faire pour venir à la fois de .NET et de Ruby..
Cela dit, comme pour la plupart des autres directives du Codex, rien n’est particulièrement complexe; Cependant, il faut tenir compte de certaines distinctions importantes lors de l'écriture de code.
Les espaces doivent être placés aux endroits suivants:
||, &&, et !)<, >, ==, ===, etc.)=)La plupart d'entre elles sont relativement simples, mais d'après mon expérience, j'ai constaté que les règles relatives aux tableaux entraînaient le plus de confusion parmi les développeurs. Voici donc une note rapide sur ce qui est considéré comme correct ou non:
// Espacement correct… $ arr [$ x] = 'foo'; $ arr [0] = 'bar'; // Espacement incorrect… $ arr [$ x] = 'bar'; $ arr [0] = 'bar';
Comme vous pouvez le constater, rien n’est terriblement compliqué, mais c’est une convention relativement facile à rater..
Cette règle est probablement la norme la plus facile à retenir de tous. En termes simples, il ne devrait pas y avoir d'espaces de fin à la fin d'une ligne de code.
Selon votre IDE, vous pouvez avoir ce filtre intégré; Dans d'autres cas, vous devrez peut-être installer un plug-in qui effectuera cette action pour vous chaque fois que vous enregistrez le fichier. Mais quoi qu’il en soit, c’est une fonctionnalité relativement facile à intégrer dans l’EDI que vous utilisez.
En outre, la plupart des éditeurs, qu’il s’agisse d’un éditeur de texte enrichi ou d’un IDE complet, doivent pouvoir activer l’affichage des tabulations et des espaces..
Affichage des onglets et des espaces dans Coda 2 Encore une fois, c’est l’une des conventions les plus simples à suivre et il est probable que votre IDE ou éditeur de choix dispose de cette fonctionnalité ou d’un plugin disponible qui vous permettra de le faire automatiquement..
Sinon, vous devriez pouvoir activer la possibilité de voir les tabulations, les espaces, les retours à la ligne, etc., de manière à pouvoir facilement identifier où les espaces de fuite sont.
Évidemment, les espaces blancs jouent un rôle important dans l'écriture de code basé sur WordPress. Dans cet article, nous avons exploré l'indentation, les onglets, les espaces, les espaces de fin et pourquoi et comment les intégrer à nos projets..
Dans le prochain article, nous allons continuer à parler des subtilités des standards de codage WordPress en examinant le style d'accolade, les expressions régulières et les nuances liées à l'utilisation de balises PHP dans notre code WordPress..
