Стандарты разработки

Опубликовано Опубликовано в рубрике prestashop, Руководство разработчика PrestaShop, Русская документация PrestaShop 1.6

Стандарты разработки

 

Следование стандартам важно, тем более при написании проектов с открытым исходным кодом, поскольку код изучают миллионы глаз, а исправление ошибок заставляет их тратить время на исправление и поиск решения. Вот почему при написании чего-либо для 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 года наши выбранные стандарты были дополнительно уточнены. Read the announcement article.

Вот стандарты, соглашения и рекомендации, которые мы выбираем после 10 мая 2016 года (для PrestaShop 1.6.1.5+ и PrestaShop 1.7):