Стандарты кодирования Magento
Недавно я начал активно работать с Magento и анализатором кода , и я хотел бы знать, каким стандартам я должен следовать.
Я пробовал Стандарты кодирования Zend, но я не хочу использовать ограничение в 80 строк, и оно также не используется в ядре.
После этого я попробовал стандарты CS2, но это тоже не работает из-за _ в различных функциях и именах классов, в которых есть _ и нет пространства имен.
Итак, существует ли еще один стандарт, которому основной код соответствует на 100%? Если нет, то разве у magento не должно быть своих собственных стандартов кодирования? У него есть собственный сайт stackexchange, разработчики расширений могли бы использовать некоторые четко определенные стандарты кодирования.
5 answers
Вы также можете попробовать Стандарт кодирования анализатора кода ЭКГ Magento
Лучшие практики Magento довольно хорошо описаны Джошем Праттом здесь . Он предлагает принять и следовать Стандартам стиля кода Zend, и я могу только присоединиться к нему.
Максимальная длина строки не является строгим требованием. Однако с точки зрения удобочитаемости слишком длинные строки не поощряются.
Вот последние Стандарты кодирования Magento marketplace для Magento1 и Magento2
MEQP2 Для Magento2
MEQP1 Для Magento1
Я хотел бы заявить, что мы должны использовать снифф кода Magento 2 в качестве стандарта как для Magento 1.X, так и для 2.X: https://github.com/cobhimself/phpcs-magento-rules/blob/master/ruleset.xml
И вот, по сути, зеркало этого набора правил в качестве отдельного репозитория: https://github.com/cobhimself/phpcs-magento-rules
Этот пост немного устарел (2008), но я думаю, что он все еще действителен:
Соответствует ли Magento стандартам кодирования ZF? Да
За некоторыми исключениями, такими как:
- в шаблонах разрешены короткие открытые теги.
- точки объединения не заключены в пробелы.
- отступ для жестких обертываний длинных строк всегда должен быть на одну мягкую вкладку вперед.
Редактировать Как Тим Уорт в комментарии, есть в шаблонах ядра Magento нет коротких открытых тегов, и в любом случае их лучше не использовать, так как они не рекомендуются (см. здесь).
Но мой вам совет... Поскольку вы пишете свой собственный модуль, используйте свой собственный стиль кодирования. По моему опыту, вы будете совершать меньше ошибок при написании кода в своем собственном стиле, с которым вы знакомы, чем если бы вы следовали стилю кодирования Magento в один день и, например, стилю кодирования Wordpress на следующий только потому, что вы пишете модуль для другого веб-сайта проект.