Как да направите коментари относно PHP: 3 стъпки

Коментарът е вид бележка, която може да се използва за обяснение на целта и стойностите на кодовия фрагмент. Работейки в PHP, ще имате няколко опции за писане на коментари, които преминаха от старите известни езици за програмиране: чрез въвеждане на единна или многорегламентация C-коментара. Можете да използвате коментарите, за да не давате фрагмент от кода, за да печелите или просто да записвате записи.

Стъпка

Част 1 от 2:

Стилове

един. Еднолинейни коментари за кратки записи. Ако трябва да оставите кратък коментар, използвайте коментар за един ред. Коментарът диктува само до края на линията или края на кодовия блок. Такива коментари работят само в PHP тагове и ще бъдат прочетени само ако ги поставите в HTML.

// Това е стандартен (C ++) начин за създаване на единна коментара. За да създадете коментар за един ред. Можете също да използвате този стил Unix ?. T

2. За да напишете дълги коментари или тест за тестване, използвайте многоречни коментари. Многоонергийните коментари са много полезни при писане на дълги обяснения и за предотвратяване на обработката на сегмента на кода. Прочетете раздела "Употреба", за да научите за някои съвети за използването на "Multi-line comments.

/ * Това е начина, по който си струва да се направи форматимнострофващ коментар. Целият учебник на края на етикета ще включва коментар * // * някои обичат да включат * до върха на всеки ред * допълнителни маркери. Тя ще подобри * четливостта на големите коментари, въпреки че не е задължително. * /?. T

Част 2 от 2:

Използване

един. Използвайте коментари за оставяне на бележки за ефективност на кода. Не е необходимо да правите това за всеки ред от кода, тъй като други програмисти могат лесно да разберат в добре написан код. Коментарите са полезни, ако кодът извършва нестандартни или не очевидни функции.

// Създаване на заявка Curl $ session = curl_init ($ asse) - // кажете на curl да използва http postcurl_setopt ($ сесия, curlopt_post, true)-

2. Оставете коментари да не забравят какво сте направили с кода. Когато работите по проект, коментарите няма да ви позволят да забравите това, което сте спрели. Оставете коментари за код, който работи неправилно или все още не сте приключили.

// преди да пристъпите към следващата стъпка, трябва да проверите резултата от тази програма "Здравей свят!"-

3. Оставете коментар за кода, който планирате да споделите. Ако планирате да си сътрудничите с други програмисти или ще направите кода си публично достъпни, коментарите ще помогнат на другите да разберат как работи кодът ви и какво трябва да се коригира.

/ * Има ли по-ефективен начин да се направи?* / Пол: Ако (ISSET ($ пол) && $ Пол =="женски пол") Ехо "Проверено"-?> Стойност ="женски пол"> Жена Ако (ISSET ($ пол) && $ Пол =="Мъжки пол") Ехо "Проверено"-?> Стойност ="Мъжки пол"> Мъж

4. Оставете коментари за отмяна на конкретни кодови блокове. Това е доста полезно, когато тествате кода и искате да спрете работата на някакъв фрагмент. Когато стартирате страницата, всичко, което е включено в етикета на коментарите, ще бъдат игнорирани.

Ехо "/ * Здравей свят!"-/ * При започване на гореспоменатия код думата "Hello" не се отразява * /?. T

пет. Бъдете внимателни, когато коментирате големи блокове код. Функцията за коментари ще завърши, когато първата маркировка за завършване печели, така че ако сте в кода, който вече сте коментирал, е много-линеен коментар, той се оказва само преди първоначалния коментар.

/ * Ехо "Здравей свят!"- / * Този коментар ще се развали * / * /?. T

/ * Ехо "Здравей свят!"- // с този коментар всичко ще бъде добре * /?. T

6. Използвайте коментари за създаване на псевдо-записващо устройство. Можете да използвате някои креати за творчески кодове, за да създадете запис за код директно вътре в него. Той е доста полезен за публично достъпни проекти.

// ============= // Заглавие // ============= // ------------- // Субтит // ------------- / * Име на секцията * / # Записи Можете да пишете тук # втората част може да бъде написана тук / * * Възползвайте се от това, за да обясните: за които ви трябва няколко реда * или дори няколко точки на обяснение * /?. T

Съвети

HTML и PHP коментарите се различават един от друг, така че при работа със сценарии (комбинация от HTML и PHP), уверете се, че използвате правилния синтаксис.
Например, в следващия код има HTML коментар, но все още изпълнява PHP код. Ако поставите коментара на HTML вътре в PHP маркера, това ще доведе.