Normes de codage Magento

J'ai récemment commencé à travailler intensivement avec Magentoet code sniffer , et je voudrais savoir quelles normes je devrais suivre.

J'ai essayé les normes de codage Zend , mais je ne veux pas utiliser la limite de 80 lignes, et elle n'est pas utilisée dans le noyau non plus.

Après cela, j'ai essayé les normes CS2 , mais cela ne fonctionne pas non plus à cause de la _diversité des fonctions et des noms de classe, qui contiennent un _et qui n'ont pas d'espaces de noms.

Alors, y a-t-il une autre norme à laquelle le code principal est conforme à 100%? Sinon, magento ne devrait-il pas avoir ses propres normes de codage? Il dispose de son propre site stackexchange, mais les développeurs d’extensions sont invités à utiliser des normes de codage bien définies.

Vous pouvez également essayer la norme de codage ECG Magento Code Sniffer

Les meilleures pratiques de Magento sont très bien décrites par Josh Pratt ici . Il suggère d'adopter et de suivre les normes de style de code Zend et je ne peux que le rejoindre.

La longueur de ligne maximale n'est pas une exigence stricte. Cependant, du point de vue de la lisibilité, les lignes trop longues ne sont pas encouragées.

Voici la dernière norme de codage du marché Magento pour Magento1 et Magento2

MEQP2 pour Magento2

MEQP1 pour Magento1

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

Je voudrais soumettre que nous devrions utiliser le renifleur de code Magento 2 comme norme pour Magento 1.X et 2.X: https://github.com/cobhimself/phpcs-magento-rules/blob/master/ ruleset.xml

Et voici essentiellement un miroir de ce jeu de règles en tant que référentiel autonome: https://github.com/cobhimself/phpcs-magento-rules

Ce post est un peu vieux (2008) mais je suppose qu'il est toujours valable:

Magento respecte-t-il les normes de codage ZF? Oui

À quelques exceptions près, telles que:

• les balises ouvertes courtes sont autorisées dans les modèles.
• les points de concaténation ne sont pas enfermés dans des espaces.
• l'indentation des longues lignes doit toujours être précédée d'un onglet.

Modifier Comme Tim Worte dans le commentaire , il n'y a pas de courtes balises ouvertes dans templatesa de base Magento et il est préférable de ne pas les utiliser de toute façon car ils ne sont pas conseillé (voir ici ).

Mais mon conseil à vous ... Puisque vous écrivez votre propre module, utilisez votre propre style de codage. D'après mon expérience, vous ferez moins d'erreurs lors de la rédaction de code dans votre propre style, ce qui vous est familier que si vous suivez un jour le style de codage Magento et par exemple le style de codage Wordpress le lendemain, simplement parce que vous écrivez un module pour un projet de site Web différent. .