Стандарты кодирования Drupal

Drupal Coding Standards (DCS) — набор требований и лучших практик, которые вы должны соблюдать когда пишете код для Drupal. Код должен не только решать свои задачи, но и хорошо выглядеть, а также быть понятным другим разработчикам.

Что такое стандарты кодирования?

Стандарты кодирования — это набор правил и договоренностей о том, как все должны писать код и форматировать его. Например, они касаются того, как называть переменные, какие отступы должны быть у кода, где должны находиться файлы и как называться, как именовать функции, объекты, аргументы и как правильно описать свой код.

Так как разработка на Drupal не ограничивается одним PHP, стандарты распространяются на все языки используемые системой.

Зачем нужны стандарты кодирования?

Повышают читаемость кода. Когда два разработчика пишут код следуя едиными стандартам и требованиям, они читают чужой код как свой собственный, быстрее понимают что делает та или иная часть бизнес-логики, примерно понимают где искать код, который им нужен, быстрее смогут подключиться к проекту, помочь доработать, исправить ошибки или улучшить функционал.

Улучшают поддерживаемость кода. Код, написанный по стандартам, намного легче поддерживать, особенно другим разработчикам. Вы снижаете порог входа в проект, что позволит другим разработчикам подключаться к вашему проекту без головной боли. Если вы получите на поддержку проект, который был сделан соблюдая стандарты, вам будет намного легче с ним работать.

Позволяют обнаруживать ошибки быстрее. Когда у вас будет опыт написания кода по стандартам, вы будете быстрее замечать части кода, которые смотрятся неестественно или неправильно, что позволяет быстрее и раньше обнаруживать ошибки.

Решают споры и разногласия. Стандарты также позволяют решать ситуации, когда один разработчик пишет код по своему, а другой по своему, любой спор и обсуждение, чей код "правильнее и красивее" в конечном итоге закончится тем, что должно быть как в стандартах, точка.

Когда мы пишем код под Drupal, мы соглашаемся с этими стандартами и следуем им. Нравятся они нам или нет, мы обязаны их соблюдать, особенно, если публикуем свой код в открытом доступе или делимся им с сообществом.

Стандарты — очень важный элемент больших OpenSource сообществ, таких как Drupal. Чтобы поддерживать кодовую базу, которая у нас имеется, помогать её постоянно улучшать и совершенствовать, мы должны выражать свои мысли в виде кода одинаково, так, вся система в целом становится более понятной и простой.

Drupal сообщество не одобряет написание кода с игнорированием стандартов.

Ссылки

PHP

Помощь и обратная связь

Если вы обнаружили ошибку или хотите внести улучшения, и желаете внести изменения самостоятельно при помощи Pull Request
Если вы желаете предложить улучшение для этого документа

Обратиться за помощью

Если вы не нашли то что искали, воспользуйтесь поиском.

Если вам нужна помощь с чем-то конкретным, обратитесь к сообществу.