Базові принципи написання коду на PHP

Якщо вирішила придбати нерухомість, до Вашої уваги квартири в івано-франківську

maque.org.ua - Базові принципи написання коду на PHP

У цьому дописі наступна частина майбутнього підручника з PHP. У цій частині йдеться про базові принципи написання коду на PHP. Як завжди, чекаю на Ваші конструктивні коменти, поради та зауваження.

Попередня глава підручника Перша програма «Hello World» (Привіт, світе)

Базові принципи написання коду на PHP
(як правильно писати код на PHP)

Вам також буде цікаво подивитись відео з допису Основні правила PHP, де значною мірою розкривається суть цієї теми.

Аби кодування та читання коду було легшим, існують правила та звичаї. PHP тут не виняток. Розглянемо основні з них:

  1. У PHP файл починається з <?php , а у кінці ставиться кінцевий PHP-теґ ?>. У будь-якому разі блок з PHP повинен відкриватись за допомогою мітки <?php. Кінцева ж мітка ?> є необов’язковою. Але це у тому разі, якщо після вашого коду більше нічого нема. Наприклад якогось HTML коду. Якщо ж ви таки поставили кінцеву мітку, переконайтесь, що після неї нема пробілу. Якщо пробіл є, то це може викликати помилки.
  2. Ім’я файлу має говорити про те, що саме це за файл. Тобто імена файлів мають бути такими, щоб по них було чітко зрозуміло, що у тих файлах. Наприклад ім’я email_addresses.php дозволяє зрозуміти, що у файлі розміщено адреси електронної пошти. До речі, тут не завадить хоча б елементарне знання англійської, аби правильно писати такі імена.
  3. Імена змінних також повинні бути такими, що пояснюють їхнє призначення ($clients_table). У нашому прикладі зрозуміло, що змінна містить таблицю з клієнтами.
  4. Структури повинні відкриватися і закриватися на одному рівні (після та перед фігурними дужками робимо пробіли):

    Перший варіант:
    [code lang=”PHP”]

    [/code]
    Другий варіант:

    [code lang=”PHP”]

    [/code]

  5. Для називання функцій можна застосувати так звану “верблюдячу нотацію”. Це коли кожне слово, окрім першого, у імені функції пишеться з великої букви: openMyFile(); Докладніше про функції у PHP я розповім у одній з наступних глав. Наразі ж головне зрозуміти сам принцип називання.
  6. Заведено на початку кожного файлу та перед функцією писати коментарі у такому форматі:
    [code lang=”PHP”]
    /**
    *якийсь коментар
    */
    [/code]
  7. Рекомендується ставити // перед або після коду, що коментуєте.
    [code lang=”PHP”]
    // якийсь коментар
    [/code]

    До речі, відео про основні види коментарів у PHP можна подивитись у дописі Основні види коментів у PHP

  8. Ще один зі способів писати початковий PHP-теґ називається shot open tag. Про нього можна почитати у дописі Мітка рівняння ASP (ASP equals tag) у PHP.
  9. Класи завжди називаються з великої букви
  10. Змінні, класи, функції потрібно називати або “горбатим” регістром, або через _. І не змішувати стилі
  11. Що ще можна додати до цього списку?

Якщо Ви бажаєте допомогти у справі написання підручника з PHP, зауважте наступні способи, як це можна зробити:

  • Якщо Ви фахівець з PHP, коментуйте, виправляйте та радьте у коментах дописів: Ваша допомога у цій справі дуже потрібна;
  • Якщо не знаєте PHP, але зараз вчите, то ставте питання у коментах;
  • Якщо вважаєте, що ця справа варта уваги та розголосу, повідомте про допис у Твітері, Фейсбуці тощо (у кінці посту є відповідні опції).

You may also like

16 коментарів

  1. додам,що пхп код я памятаю можна починати навіть так

  2. 1. Мне кажется, что утверждение по поводу использования тэга ?> “є необов’язковою, ба — навіть небезпечною” слишком категорично. Есть “культура написания кода” и мне кажется этот тэг стоит писать, просто смотреть, чтобы после него не было пробелов или пустых строк

    2. Стоит в статье упомянуть и короткий открывающий тэг (short open tag) <? который действительно лучше не использовать, если не уверен что сервер не настроен на поддержку short open tags. И даже в этом случае лучше все-таки писать полный тэг <?php

  3. В реальних проектах потрібно дуже часто закривати php код за допомогою ?›. Дуже важливим доповненням до цього уроку буде те, що великі шматки html потрібно виносити за межі php коду і не засувати їх у оператори типу echo. Це значно підвищує зрозумілість коду і не засмічує його.
    Наприклад:

    ‹?php PHP 1 ?›
    HTML 1
    ‹?php PHP 2 ?›
    HTML 2
    javascript 1
    ‹?php PHP 3 ?›

    І так стільки скільки потрібно. Не треба писати все в середині одних і тих же тегів php.

  4. @ taras:
    Даруйте, що саме Ви хотіли написати? Ваш код не видно.

  5. @ gordon:
    1. Дякую за пораду. Підправив. 🙂

    2. А short open tag днями допишу.

  6. код видно сайт “зїв”, та нічого,я чкраз про скорочені теги і писав

  7. Хороші поради.
    Колись працював з великим проектом, в якому майже весь HTML виводився через “ЕХО” різними функціями. Важкувато деколи було знайти потрібне.

  8. @ admin:
    А чому так сталося. І весь код взагалі не на одному рівні розміщений.

  9. Кхе-кхе…

    В 4 пункті додайте відступи для коду всередині фігурних дужок, а то початківці так не читабельно будуть писати.

    З іменуванням якось наплутано. Потрібно зауважити, що:
    – Класи завжди називаються з великої букви
    – Змінні, класи, функції потрібно називати або “горбатим” регістром, або через _. І не змішувати стилі.

  10. @ adviser:
    Дякую. Нібито виправив, якщо я Вас правильно зрозумів. Якщо ні, поясніть. Дякую 🙂

  11. @ black0wolf:
    Не зовсім розумі, що Ви маєте на увазі …