Правила оформлення PHP-коду, Bitrix Qiuck Start
Дотримання стандартів
- Як відступи в коді використовується табуляція.
- Відкриваюча фігурна скобра знаходиться в тому ж рядку.
- Фігурна дужка, що закриває, знаходиться на новому рядку.
Коментування коду
Коментування коду PHP – його невід'ємна частина!
Змінні
В іменах змінних використовуються такі префікси:
- ar - для масивів
- db - для CDBResult
- b - для булевих змінних, якщо з імені не очевидно. Перфікс обов'язковий, якщо булеве значення використовується там, де зазвичай зберігається рядковеY/N.
Імена змінних не повинні починатися з підкреслення.
Глобальні змінні
Глобальні змінні пишуться ВЕЛИКИМИ літерами з поділом слів знаком підкреслення.
Використання глобальних змінних допускається лише там, де це необхідно. Використовуйте те, що дає D7, там, де це дає!
Локальні змінні
Локальні для скрипту (функції, методу, класу) змінні починаються завжди з маленької літери, слова поділяються на капіталізацію першого символу (camelCase).
Це правило поширюється на абревіатури. Тобто. станція BBC пишеться $bbcStation; $arBbcStations; .
Виняток лише одне — ID записується великими. Тобто. $sectionID , $arElementIDs .
Допоміжні (тимчасові) змінні
Змінні, що використовуються у конструкціях FOR. FOREACH, можна назвати скорочено, якщо код блоку, у якому вони використовуються, проглядається без прокрутки сторінки.
Імена констант записуються ВЕЛИКИМИ літерами, слова поділяються знаком підкреслення. У зв'язку із глобальною областювидимості константи необхідно передувати коротким префіксом (на ім'я модуля, компонента, шаблону).
Символьні коди Бітрікс
Сомвольні коди в бітріксі потрібні для багатьох речей і тому слід дотримуватись одноманітного їх найменування. Символьний код має бути написаний латинськими літерами, без цифр та спецсимволів, і повинен відображати суть інфоблоку, розділу чи елемента.