Share
Auf dieser Site verbringen wir viel Zeit damit, Informationen auszutauschen und zu besprechen, wie bestimmte Dinge mit WordPress erledigt werden können. Immerhin der Zweck der Website ist um Tutorials anzubieten - das heißt, wir versuchen praktische Ratschläge zu geben, wie bestimmte Dinge mithilfe der Plattform erstellt werden können.
Bei der Entwicklung geht es jedoch nicht nur darum, Code zu schreiben und Dinge zu bauen. Es geht auch darum, qualitativ hochwertigen, wartbaren Code zu schreiben, den Status unserer Projekte zu überarbeiten und zu verbessern und generell zu versuchen, eine Codebase in einem besseren Zustand zu lassen, als wir es gefunden haben (oder als wir mit der Erstellung begonnen haben)..
Anstatt sich darauf zu konzentrieren, wie Sie etwas erstellen oder einen bestimmten Code überprüfen, sollten wir uns ein paar praktische Tipps zum Schreiben von qualitativ hochwertigem WordPress-Code ansehen.
In erster Linie - und obwohl wir viel darüber diskutieren - ist es eine Wiederholung wert:
Das Befolgen der WordPress-Codierungsstandards ist eine der wichtigsten Funktionen, die Sie beim Schreiben von Designs, Plugins oder Anwendungen ausführen können.
Für diejenigen, die nicht vertraut sind, enthalten die WordPress-Codierungsstandards Regeln, wie wir unser WordPress-basiertes PHP formatieren sollten. Natürlich gibt es nichts zu erzwingen Die Regeln - Sie können sie ignorieren (und viele tun dies), aber es ist eine bewährte Methode für diejenigen, die ernsthaft an der Entwicklung von WordPress-basierten Projekten arbeiten, und es wird von denjenigen respektiert, die in der Community aktiv sind.
Darüber hinaus bedeutet das Befolgen von Codierstandards, dass wir - zusammen mit allen anderen Entwicklern, die dies tun - einen ähnlich aussehenden Code haben. Tatsächlich besteht eines der Ziele definierter Codierungsstandards darin, dass der Code so aussieht, als wäre er von einem einzelnen Entwickler geschrieben worden.
Ein weiterer Vorteil dabei ist, dass es anderen auch leicht fällt, einen Beitrag zu unserer Codebase zu leisten. Schließlich, da WordPress und seine abgeleiteten Werke Open Source sind, möchten andere vielleicht mitkommen und sich abspalten oder dazu beitragen, dass sie unseren Code leicht lesen können.
Schließlich ist dies nicht unbedingt ein Aufruf zum Handeln, um alles, was Sie bisher getan haben, neu zu gestalten. Jetzt ist es eine gute Zeit, die Standards zu befolgen. Gute Entwickler verbessern sich ständig, daher ist es absolut akzeptabel, jetzt zu beginnen (selbst wenn es mitten in einem Projekt ist)..
Wenn Sie Code schreiben, können Sie am besten hilfreiche Kommentare hinterlassen, die genau erklären, was Sie gerade tun.
Natürlich können Kommentare auf Klassenebene, Funktionsebene und Zeilenebene leben. Sie sind in PHP, HTML, JavaScript und CSS zulässig, es gibt also keine Entschuldigung nicht sie irgendwo einschließen.
Sicher, das Verfassen von Kommentaren erfordert etwas mehr Zeit, aber denken Sie daran, dass das Lesen von Code keinen Code heißen würde, wenn er einfach zu lesen wäre.
Stellen Sie sich das so vor: Programmierer sind dafür bekannt, zu ihren vorherigen Projekten zurückzukehren und zu erkennen, wie schlecht ihr Code ist oder wie wir etwas anderes machen würden, wenn wir jetzt an diesem Projekt arbeiten würden.
Wenn wir das über unseren eigenen Code sagen, was müssen andere denken, wenn sie unseren Code sehen, insbesondere wenn sie aus einem erfahreneren Hintergrund stammen?
Weitere Informationen zum Kommentieren von serverseitigem und clientseitigem Code finden Sie in dieser Reihe.
Eine andere Sache, die wir Entwickler tun können, ist die Vereinfachung unserer Funktionen. Obwohl mir klar ist, dass dies ein eher subjektiver Bereich ist, denke ich, dass das Anzielen kleinerer, fokussierter Funktionen den Code lesbarer macht und letztendlich zur Testbarkeit beitragen kann (wenn Sie daran interessiert sind, diesen Weg zu gehen)..
Erstens ist es nicht ungewöhnlich, Funktionen zu sehen, die 30, 40 oder 50 Zeilen überschreiten. Das Problem ist, dass diese Funktionen oft mehr als eine Sache tun.
Das ist problematisch, weil:
Daher gibt es einige praktische Tipps, mit denen wir die Qualität unserer Funktionen verbessern können.
Wenn Sie feststellen, dass Sie immer wieder dasselbe zwischen verschiedenen Funktionen schreiben, dann müssen Sie diesen Teil des Codes extrahieren und in eine eigene Funktion verschieben, damit er von allen Stellen aufgerufen werden kann es existiert derzeit.
Wenn Sie feststellen, dass Ihr Code entweder mit Kommentaren kompliziert zu beschreiben ist oder beim Lesen schwer nachzuvollziehen ist, lohnt es sich möglicherweise, einen Schritt zurückzutreten und den Code in etwas einfacheres zu überarbeiten.
Dies sieht in jeder Situation anders aus, aber das Streben nach Lesbarkeit über Komplexität ist oft ein besseres Ziel, das angestrebt werden muss, als nur etwas zum Laufen zu bringen.
Dies ist wahrscheinlich der subjektivste Punkt. Ich denke, es ist eine Überlegung wert, und das ist einfach so, dass wir uns bemühen sollten, unsere Funktionen mit 20 Zeilen klein zu halten, eine relativ solide Länge, auf die Sie zielen können. Sicher, dies kann eine Herausforderung sein, da WordPress häufig große Arrays erstellt, die als Argumente übergeben werden sollen. Sie haben jedoch die Idee, sie klein, fokussiert und wartbar zu halten.
Ja, dies führt zu mehr Funktionen, aber der Code ist einfacher zu lesen und zu verwalten, da jede Funktion nur einen bestimmten Zweck hat. Dies bedeutet, dass Sie sie eindeutiger benennen und einfacher Komponententests durchführen können.
Offensichtlich sind keine der obigen Regeln strenge Regeln, die befolgt werden müssen. Sie sind lediglich Vorschläge, wie die Qualität des von uns geschriebenen Codes verbessert werden kann, die wir beibehalten und dass wir zur Arbeit anderer beitragen.
Vor allem glaube ich, dass wir uns um Lesbarkeit und Testbarkeit bemühen sollten. Wenn diese beiden Ziele im Vordergrund stehen, hilft uns unsere Arbeit, alles andere an seinen richtigen Platz zu bringen.
Natürlich ist dies keine vollständige Liste - es ist weit davon entfernt! Geben Sie bitte Ihre Vorschläge in den Kommentaren an!
Accentsconagua