Стандарты разработки
Следование стандартам важно, тем более при написании проектов с открытым исходным кодом, поскольку код изучают миллионы глаз, а исправление ошибок заставляет их тратить время на исправление и поиск решения. Вот почему при написании чего-либо для PrestaShop, будь то тема, модуль или основной патч, вы должны стремиться следовать следующим рекомендациям. Это рекомендации, которых придерживаются разработчики PrestaShop, и следование им — самый надежный способ, чтобы ваш код был элегантно интегрирован в PrestaShop.
Короче говоря, следование стандартам кода помогает сохранить читаемый и обслуживаемый код.
Начиная с версии 1.6.1.0, базовый стандарт PrestaShop переключился на PSR-1 coding standard и PSR-2 coding style guide. Причины описаны в announcement article .
Существующие модули и темы не требуют переключения на PSR-1 и PSR-2.
Предполагается, что собственные модули PrestaShop и заново созданные модули сообщества будут применять эти рекомендации.
Если вы хотите обновить свой код PHP до инструкций PSR-1 и PSR-2, вы можете использовать PHP Coding Standards Fixer, который исправляет большинство проблем автоматически.
Для справки, старые стандарты кодирования PrestaShop хранятся на этой странице: Pre-1.6.1.0 PHP Coding Standards. Пожалуйста, не используйте их!
Вот стандарты, соглашения и рекомендации, которые мы выбираем после 10 мая 2016 года (для PrestaShop 1.6.1.5+ и PrestaShop 1.7):
- PHP code
We keep PSR-1 and PSR-2, along with a few nice details from Symfony. - JavaScript code
We choose to follow the Airbnb JavaScript Style Guide. - HTML & CSS code
We choose to follow the Mark Otto’s coding standards. Mark is the creator of the Bootstrap framework. - Smarty / Twig code
Same standards as with HTML & CSS. - Commits & Pull-requests conventions
We choose to formalize best practices. - SQL guidelines
Same as before.