Magento-Codierungsstandards

Ich habe vor kurzem intensiv mit Magentound Code Sniffer gearbeitet und möchte wissen, welchen Standards ich folgen soll.

Ich habe versucht, Zend-Codierungsstandards zu verwenden , aber ich möchte das 80-Zeilen-Limit nicht verwenden, und es wird auch nicht im Core verwendet.

Danach habe ich CS2-Standards ausprobiert , aber das funktioniert auch nicht, weil _in verschiedenen Funktionen und Klassennamen ein _und keine Namespaces enthalten sind.

Gibt es also einen anderen Standard, dem der Kerncode zu 100% entspricht? Wenn nicht, sollte Magento nicht seine eigenen Codierungsstandards haben? Es hat eine eigene Stack-Exchange-Site. Einige gut definierte Codierungsstandards können gerne von Erweiterungsentwicklern verwendet werden.

Sie können auch den Magento Code Sniffer Coding Standard für EKGs ausprobieren

Die Best Practices von Magento werden von Josh Pratt hier recht gut beschrieben . Er schlägt vor, die Zend Code Style Standards zu übernehmen und zu befolgen, und ich kann ihm nur beitreten.

Die maximale Zeilenlänge ist nicht zwingend erforderlich. Aus Sicht der Lesbarkeit werden jedoch zu lange Zeilen nicht empfohlen.

Hier sind die neuesten Magento-Marktplatz-Codierungsstandards für Magento1 und Magento2

MEQP2 Für Magento2

MEQP1 Für Magento1

https://github.com/magento/marketplace-eqp

Ich möchte einreichen, 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

Dieser Beitrag ist ein bisschen alt (2008), aber ich vermute, dass er noch gültig ist:

Befolgt Magento die ZF-Kodierungsstandards? Ja

Mit wenigen Ausnahmen wie:

• Kurze offene Tags sind in Vorlagen zulässig.
• Verkettungspunkte werden nicht in Leerzeichen eingeschlossen.
• Einrückung für lange Zeilen Harte Zeilenumbrüche sollten immer eine weiche Lasche vor sich haben.

Bearbeiten Als Kommentar zu Tim gibt es in Magento-Kernvorlagen keine kurzen offenen Tags, und es ist am besten, sie 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 werden Sie weniger Fehler machen, wenn Sie Code in Ihrem eigenen Stil schreiben, den Sie kennen, als wenn Sie den Magento-Codierungsstil eines Tages und z. B. den Wordpress-Codierungsstil des nächsten Tages befolgen, nur weil Sie ein Modul für ein anderes Website-Projekt schreiben .