44  /  382
Справочник

Общие правила оформления кода

Просмотров: 23478
Дата последнего изменения: 09.11.2022
Роберт Басыров
Сложность урока:
2 уровень - несложные понятия и действия, но не расслабляйтесь.
1
2
3
4
5
Недоступно в лицензиях:
Ограничений нет

Отступы

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

В PHPStorm настройте поля Показ невидимых символов, Табуляция вместо пробелов.

Кодировка

UTF-8 фактически стал стандартом, хотя клиенты Bitrix Framework иногда установливают продукт в кодировке ANSI.

Перевод строки

Строки должны заканчиваться только символом перевода на новую строку (LF) - стандарт для текстовых файлов в Unix-системах. Не используйте комбинацию символов возврата каретки/перевода строки (CRLF), как это принято в Windows.

В PHPStorm настройте поле Перевод строки для новых файлов. В нижней статусной строке показывается, какой перевод строки используется для текущего файла (должен быть LF).

Максимальная длина строки

Длина строки не должна превышать 120 символов. Настройте редактор кода так, чтобы он отображал правую границу строк.

В PHPStorm настройте поля Показ правой границы, Ширина правой границы.

Регистр

Названия тегов, атрибутов и названия классов должны быть всегда в нижнем регистре.

Пробелы в конце строки

Убирайте пробелы в конце строки. Пробелы в конце строк не обязательны и усложняют сравнение файлов в системе контроля версий.

В PHPStorm настройте поле Удаление пробелов перед сохранением файла.

Комментарии

Все комментарии должны быть на английском языке.

Курсы разработаны в компании «1С-Битрикс»

Если вы нашли неточность в тексте, непонятное объяснение, пожалуйста, сообщите нам об этом в комментариях.
Развернуть комментарии