Melbis Shop6Прийняті позначення
Для полегшення сприйняття програмного коду, а також для сумісності модулів різних розробників ми наполегливо рекомендуємо користуватися такими правилами під час вибору назв для змінних і функцій:
| Тип | Опис | Приклад |
|---|---|---|
| Найменування кореневих скриптів | Нижній регістр із роздільником слів - знаком підкреслення. | index.php, goods_compare.php |
| Найменування модульних скриптів | Перше слово в назві скрипта - це ім'я компанії або її абревіатура, друге слово - це назва групи, до якої групуються модулі, і, нарешті, третє і наступні слова - це слова на Ваш розсуд, що пояснюють, що робить скрипт. Як роздільники між словами використовується знак підкреслення. | melbis_inc.php, melbis_web_test.php, melbis_cataloge_sub.php |
| Назви функцій у модульних скриптах | У кожному звичайному модульному скрипті (за винятком модулів-бібліотек) обов'язково має бути головна функція, яка викликається автоматично. Головна функція модуля називається так само, як і сам скрипт, але повністю у верхньому регістрі. Інші функції в скрипті вказуються в нижньому регістрі з поділом слів знаком підкреслення. При цьому на початку їхньої назви як префікс має стояти ім'я головної функції. Таким чином, забезпечується унікальність імен функцій, а також поліпшується читабельність коду. Якщо Ви використовуєте функцію з бібліотеки, то за її назвою можна визначити, в якому скрипті вона знаходиться. |
Ім'я модуля: melbis_web_test.php Головна функція скрипта: function MELBIS_WEB_TEST($mVars) Допоміжна функція: function MELBIS_WEB_TEST_func($mId, $mName) |
| Назва ключів у HTML-шаблонах | Верхній регістр; як роздільник слів - знак підкреслення. | {MAIN}, {PAGE_NAME}, {HTML_CODE} |
| Глобальні змінні в скриптах | Починаються з літери "g" у нижньому регістрі, далі кожне слово з великої літери. Абревіатури пишуться як звичайні слова. Для парсера рекомендується використовувати ім'я $gParser, для роботи функції автозавершення коду. | $gParser, $gTitleHtmlPage |
| Локальні змінні всередині скриптів | Нижній регістр; як роздільник слів - знак підкреслення. Для SQL-запитів рекомендується використовувати змінну $command, для автоматичного підсвічування синтаксису SQL. | function any_value() { ... $i = 1; $item_count = 5; ... } |
| Вхідні змінні для функцій | Починаються з літери "m" у нижньому регістрі, далі кожне слово з великої літери. Абревіатури пишуться як звичайні слова. У головній функції модульних скриптів рекомендується використовувати змінну $mVars для масиву вхідних параметрів. | function MELBIS_WEB_TEST_func($mId, $mName) { ... } function MELBIS_WEB_TEST($mVars) { ... } |
| Константи в PHP-скриптах | Усі букви у верхньому регістрі; як роздільник слів - знак підкреслення. | define('FOLDER', './'); define('DB_NICK', 'MS'); |