Як робити коментарі на php: 3 кроків

Коментар - це вид примітки, яке може бути використане для пояснення мети і значення фрагмента коду. Працюючи в PHP, у вас буде кілька варіантів написання коментарів, які пішли від старих відомих мов програмування: шляхом введення однорядкових або багаторядкових С-коментарів. Ви можете використовувати коментарі, щоб не дати фрагменту коду заробити або просто для ведення записів.

кроки

Частина 1 з 2:

стилі

1. Однорядкові коментарі для коротких записів. Якщо вам необхідно залишити короткий коментар, скористайтеся кодом для однострочного коментаря. Коментар перетинаються лише до кінця лінії або кінця блоку коду. Такі коментарі працюють лише всередині міток PHP і будуть прочитані тільки, якщо помістити їх в HTML.

// Це стандартний (С ++) спосіб створення однострочного коментаря # Для створення однострочного коментаря ви також можете скористатися цим стилем Unix ?>

2. Для написання довгих коментарів або тестування коду скористайтеся багаторядковими коментарями. Багаторядкові коментарі дуже корисні при написанні довгих пояснень і для запобігання обробки сегмента коду. Прочитайте розділ «Використання», щоб дізнатися про деякі радах по використанню «багаторядкових коментарів.

/ * Ось як стоїть форматіроватьмногострочний коментар. Весь текстдо кінця мітки буде включенв коментар * // * Деяким подобається включати * на початок кожної лінії * додаткові маркери. Це поліпшить * читабельність великих коментарів, хоча і не є обов`язковим. * /?>

Частина 2 з 2:

Використання

1. Використовуйте коментарі для залишення заміток по працездатності коду. Ви не зобов`язані це робити для кожної лінії коду, так як інші програмісти без праці розберуться в добре написаному коді. Коментарі корисні в тому випадку, якщо код виконує нестандартні або не очевидно функції.

// Створіть запит curl $ session = curl_init ($ request) - // Скажіть curl скористатися HTTP POSTcurl_setopt ($ session, CURLOPT_POST, true)-

2. Залишайте коментарі, щоб не забути, що ви робили з кодом. При роботі над проектом коментарі не дадуть вам забути, на чому ви зупинилися. Залиште коментарі для коду, який неправильно працює або який ви ще не закінчили.

// Перед тим, як перейти до наступного кроку, необхідно перевірити ще раз результат цієї программиecho "Hello World!"-

3. Залиште коментар для коду, яким ви плануєте поділитися. Якщо ви плануєте співпрацювати іншими програмістами або збираєтеся зробити свій код загальнодоступним, коментарі допоможуть іншим зрозуміти, як ваш код працює і що слід поправити.

/ * Чи є більш ефективний спосіб це виконати?* / Gender: if (isset ($ gender) && $ Gender == "female") echo "checked"-?> Value = "female"> Female if (isset ($ gender) && $ Gender == "male") echo "checked"-?> Value = "male"> Male

4. Залишайте коментарі для скасування роботи конкретних блоків коду. Це досить корисно, коли ви тестируете код і хочете зупинити роботу якогось його фрагмента. При запуску сторінки все, що включено в мітку коментаря, буде ігноруватися.

echo "/ * Hello * / World!"- / * При запуску вищезгаданого коду слово« Hello »відображено не буде * /?>

5. Будьте обережні при коментуванні великих блоків коду. Функція коментування закінчиться тоді, коли запрацює перша мітка завершення, тому якщо всередині коду, який ви вже коментували, знаходиться багатостроковий коментар, він простягнеться лише до початку початкового коментаря.

/ * Echo "Hello World!"- / * Цей коментар все зіпсує * / * /?>

/ * Echo "Hello World!"- // З цим коментарем все буде добре * /?>

6. Скористайтеся коментарями для створення псевдозапісей. Ви можете скористатися деякими креативними форматами кодів для створення запису для коду прямо всередині нього. Це досить корисно для загальнодоступних проектів.

// ============= // ЗАГОЛОВОК // ============= // ------------- // підзаголовок // ------------- / * Назва розділу * / # Записи можна написати сюди # Другу частину можна написати сюди / * * Скористайтеся цим для пояснення того, * для чого знадобиться кілька ліній * або навіть кілька пунктів пояснення * /?>

Поради

Коментарі HTML і PHP відрізняються один від одного, тому при роботі зі сценаріями (поєднання HTML і PHP), переконайтеся, що використовуєте правильний синтаксис.
Наприклад, в наступному коді знаходиться коментар HTML, але він все одно виконує код PHP. Якщо ви помістіть коментар HTML всередині мітки PHP, це призведе до помилки.