Magento -Codierungsstandards
-
16-10-2019 - |
Frage
Ich habe kürzlich angefangen, ausführlich mit zu arbeiten Magento
und Code Sniffer, und ich würde gerne wissen, welchen Standards ich folgen sollte.
Ich habe es versucht Zend -Codierungsstandards, aber ich möchte das Zeilengrenze von 80 nicht verwenden und es wird auch im Kern nicht verwendet.
Danach versuchte ich es CS2 -Standards, aber das funktioniert auch wegen der _
in verschiedenen Funktionen und Klassennamen, die eine haben _
in ihnen, und haben keine Namespaces.
Gibt es einen weiteren Standard, mit dem der Kerncode 100% entspricht? Wenn nicht, sollte Magento nicht seine eigenen Codierungsstandards haben? Es hat eine eigene Stackexchange -Site, einige gut definierte Codierungsstandards wären willkommen, um von Erweiterungsentwicklern verwendet zu werden.
Lösung
Sie können es auch versuchen EKG Magento Code Sniffer Coding Standard
Andere Tipps
Magento Best Practices sind ziemlich gut von Josh Pratt beschrieben hier. Er schlägt vor, die zu adoptieren und dem zu folgen Zend -Code -Stilstandards Und ich kann mich ihm nur anschließen.
Das Maximale Linienlänge ist keine strenge Anforderung. Aus den Sicht der Lesbarkeit werden jedoch zu lange Zeilen nicht gefördert.
Hier sind die neuesten Magento Marketplace -Codierungsstandard zum Magento1 und Magento2
MEQP2 für Magento2
MEQP1 für Magento1
Ich möchte angeben, dass wir den Magento 2 -Code -Sniff als Standard für Magento 1.x und 2.x verwenden sollten:https://github.com/cobhimself/phpcs-magento-rules/blob/master/ruleset.xml
Und hier ist im Wesentlichen ein Spiegel dieses Regelsatzes als eigenständiges Repository:https://github.com/cobhimself/phpcs-magento-rules
Dies Post ist ein bisschen alt (2008), aber ich denke, dass er immer noch gültig ist:
Verfolgt Magento den ZF -Codierungsstandards? Ja
Mit wenigen Ausnahmen, wie:
- In Vorlagen sind kurze offene Tags erlaubt.
- Verkettungspunkte sind nicht in Räumen eingeschlossen.
- Eindrückung für lange Linien Harte Wraps sollten immer ein weicher Registerkarten vorwärts sein.
Bearbeiten Als Tim Worte im Kommentar gibt es keine kurzen offenen Tags in Magento Core Templatesa und es ist am besten, sie sowieso nicht zu verwenden, da sie nicht empfohlen werden (siehe hier).
Aber mein Rat an Sie ... da Sie Ihr eigenes Modul schreiben, verwenden Sie Ihren eigenen Codierungsstil. Aus meiner Erfahrung machen Sie weniger Fehler beim Schreiben von Code in Ihrem eigenen Stil, mit dem Sie vertraut sind, als wenn Sie den Magento -Codierungsstil eines Tages und z. .