Die WordPress-Codierungsstandards Einrückung, Speicherplatznutzung und nachfolgende Speicherplätze

Der gesamte Zweck dieser Serie soll dabei helfen, die WordPress-Codierungsstandards aufzuzeigen, warum sie wichtig sind und wie man qualitativ hochwertigen WordPress-Code schreibt. Um dies zu tun, betrachten wir jeden Abschnitt der WordPress-Codierungsstandards eingehend.

Bisher haben wir Folgendes behandelt:

  • Namenskonventionen und Funktionsargumente
  • Einfache und doppelte Anführungszeichen

Heute werden wir uns mit der Bedeutung des weißen Raums beschäftigen. Insbesondere werden Einrückung, Speicherplatznutzung und nachfolgende Leerzeichen behandelt. So einfach es klingt, dies sind einige der am meisten ignorierten oder missbräuchlichen Aspekte der Kodierungsstandards.


Ein Wort über Whitespace

Bevor wir uns mit den verschiedenen Codierungsstandards befassen, ist es wichtig zu verstehen, warum Leerzeichen nicht nur in WordPress wichtig sind, sondern allgemein in Programmiersprachen.

Einfach gesagt, weil es die Lesbarkeit verbessert.

Aus diesem Grund sind einige Programmiersprachen durch Leerzeichen oder durch Tabulatoren voneinander getrennt. Aus diesem Grund müssen Sie bei bestimmten Programmiersprachen bestimmte Teile des Codes wie Funktionsparameter, Array-Indizes usw. ausgeben.

Wenn es um WordPress geht, gelten die Konventionen nicht nur für die Lesbarkeit, sondern auch für eine konsistente Lese- und Entwicklungserfahrung für alle, die an WordPress-Themes, Plugins, Anwendungen oder der Kernanwendung selbst arbeiten.

Merken: Der Zweck der Kodierung von Standards besteht darin, den Quellcode so aussehen zu lassen, als würde er von einem einzelnen Entwickler geschrieben, da er die Erwartungen an die beitragenden Entwickler festlegt.


Vertiefung

Bezüglich der Einrückung gibt es nichts besonders Neues, Revolutionäres oder etwas anderes, was sich auf WordPress bezieht. Im Allgemeinen werden Sie jedes Mal einrücken, wenn Sie einen neuen Block beginnen.

Das bedeutet, dass:

  • Ihre Funktionen werden innerhalb der Klasse eingerückt
  • Ihre Bedingungen und Schalter / Fälle und andere Blöcke werden innerhalb ihrer Funktionen eingerückt
  • Ihre Schleifen werden innerhalb ihrer Funktionen, innerhalb ihrer Bedingungen usw. eingerückt

Wenn Sie es gewohnt sind, Code in Sprachen im C-Stil zu schreiben, gibt es hier nichts besonders Neues?

Ein Beispiel, wie dies aussehen könnte, ist genau dies:

 Funktion foo ($ arguments) if (0 < count( $arguments )  foreach ( $arguments as $arg => $ value) echo $ value; 

Gemäß den Kodierungsstandards:

Ihre Einrückung sollte immer die logische Struktur widerspiegeln. Benutzen echte tabs und keine Leerzeichen, da dies die größte Flexibilität für Kunden ermöglicht.

Die wichtigsten Schritte sind, dass der Anfang von Zeilen mit Tabulatoren beginnt und dass der Code a darstellt logisch Struktur. Nicht zu kompliziert machen oder versuchen, die Dinge zu stark zu vereinfachen.

Es gibt noch eine weitere Nuance für den Leerraum innerhalb der WordPress-Codierstandards: Am Anfang der Zeile sollten Tabulatoren verwendet werden, an anderen Stellen sollten jedoch Leerzeichen verwendet werden. Meist ist dies eine einfache Regel, die befolgt werden muss. In WordPress erstellen Sie jedoch häufig Arrays, die als Argumente übergeben werden.

Im Idealfall möchten wir, dass jeder Index des Arrays so ausgerichtet wird, dass die Lesbarkeit so hoch wie möglich ist. Oft neigen wir jedoch dazu, Registerkarten zu verwenden, um das Anordnen zu erleichtern. Dies ist jedoch eine Verletzung der Kodierungsstandards.

 $ args = array ('ID' => 1, 'post_title' => 'Der Titel', 'post_content' => 'Der Inhalt');

Stellen Sie daher sicher, dass Sie nur Verwenden Sie Tabulatoren am Anfang jeder Zeile.


Raumnutzung

In Bezug auf WordPress habe ich festgestellt, dass Leerzeichen weitaus großzügiger genutzt wurden als in anderen Sprachen. Ich sage das nicht nur als eine Beobachtung, es war eine persönliche Anpassung, die ich machen musste, um sowohl von .NET als auch von Ruby zu kommen.

Wie bei den meisten anderen Richtlinien im Kodex gibt es nichts besonders Komplexes. Es gibt jedoch einige wichtige Unterschiede, die beim Schreiben von Code zu beachten sind.

Leerzeichen sollten an folgenden Stellen platziert werden:

  • Nach Kommas
  • Auf beiden Seiten logischer Operatoren (das heißt, ||, &&, und !)
  • Auf beiden Seiten von Vergleichsoperatoren (das heißt, <, >, ==, ===, usw.)
  • Auf beiden Seiten der Zuweisungsoperatoren (nämlich =)
  • Auf beiden Seiten der öffnenden und schließenden Klammer von Funktionen, Bedingungen, Schleifen usw..
  • Wenn eine Variable als Index eines Arrays übergeben wird, aber nicht wenn ein Literalwert (z. B. ein String oder eine Ganzzahl)

Die meisten davon sind relativ unkompliziert, aber nach meiner Erfahrung habe ich herausgefunden, dass die Array-Regeln bei den Entwicklern die meisten Verwirrungen verursachen. Daher hier ein kurzer Hinweis darauf, was als richtig gilt und was nicht:

 // Abstand korrigieren… $ arr [$ x] = 'foo'; $ arr [0] = 'bar'; // falscher Abstand… $ arr [$ x] = 'bar'; $ arr [0] = 'bar';

Wie Sie sehen, ist das alles nicht sehr kompliziert, aber es ist eine relativ einfache Konvention, die man übersehen kann.


Nachgestellte Leerzeichen

Diese Regel ist wahrscheinlich der einfachste Standard, um sich an alle zu erinnern. Vereinfacht ausgedrückt, sollten am Ende einer Codezeile keine Leerzeichen stehen.

Abhängig von Ihrer IDE kann dieser Filter eingebaut sein. In anderen Fällen müssen Sie möglicherweise ein Plugin installieren, das diese Aktion für Sie ausführt, wenn Sie die Datei speichern. Was auch immer der Fall ist, es ist eine relativ einfache Funktion, die in jede von Ihnen verwendete IDE integriert werden kann.

Außerdem sollten die meisten Editoren - unabhängig davon, ob es sich um einen verbesserten Texteditor oder einen vollständigen IDE-Editor handelt - die Möglichkeit haben, die Anzeige von Registerkarten und Leerzeichen zu aktivieren.

Anzeigen von Tabs und Whitespace in Coda 2

Auch dies ist eine der einfachsten Konventionen, die zu befolgen ist, und es ist wahrscheinlich, dass Ihre IDE oder der Editor Ihrer Wahl diese Funktion oder ein Plugin zur Verfügung hat, mit denen Sie dies automatisch tun können.

Wenn nicht, sollten Sie die Möglichkeit aktivieren, Registerkarten, Leerzeichen, Wagenrückläufe usw. anzuzeigen, damit Sie sie leicht erkennen können woher die nachgestellten Leerzeichen sind.


Fazit

Offensichtlich spielt der Leerraum beim Schreiben von auf WordPress basierenden Code eine wichtige Rolle. In diesem Artikel haben wir Einrückungen, Registerkarten, Leerzeichen, nachgestellte Leerzeichen und warum und wie sie in unsere Projekte integriert werden können, untersucht.

Im nächsten Artikel werden wir weiter über die Feinheiten der WordPress-Codierstandards sprechen, indem wir den Klammerstil, reguläre Ausdrücke und die Nuancen der Verwendung von PHP-Tags durch unseren WordPress-Code betrachten.