251  /  328

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

Просмотров: 1336 (Статистика ведётся с 06.02.2017)
Дата последнего изменения: 21.07.2017

Отступы

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

Настройка PHPStorm:
Показ невидимых символов: Preferences > Editor > General > Appearence > Show Whitespaces.
Табуляция вместо пробелов: Preferences > Editor > Code Style > (PHP|HTML|CSS|JavaScript) > Use tab character.

Кодировка

Несмотря на то, что UTF-8 фактически стал стандартом, клиенты Bitrix Framework могут установить продукт либо в кодировке ANSI, либо в UTF-8. Исходной кодировкой репозитария для разработчиков является windows-1251. В этой кодировке должны создаваться и редактироваться все текстовые файлы.

Настройка PHPStorm:
Кодировка файлов проекта: Editor > File Encodings. Укажите windows-1251.
В нижней статусной строке показывается, какая кодировка используется для текущего файла (должна быть windows-1251).

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

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

Настройка PHPStorm:
Перевод строки для новых файлов: Editor > Code Style > Line separator (for new files) > Unix and OS X \n.
В нижней статусной строке показывается, какой перевод строки используется для текущего файла (должен быть LF).

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

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

Настройка PHPStorm:
Показ правой границы: Editor > General > Appearence > Show right margin
Ширина правой границы: Editor > Code Style > Right margin (columns

Регистр

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

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

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

Настройка PHPStorm:
Удаление пробелов перед сохранением файла: Editor -> General -> Strip Trailing Spaces on Save.

Комментарии

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

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

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