Jak udělat komentáře k PHP: 3 kroky

Komentář je typ poznámky, kterou lze použít k vysvětlení účelu a hodnot fragmentu kódu. Práce v PHP budete mít několik možností pro psaní komentářů, které šel ze starých známých programovacích jazyků: zadáním jednorázového nebo více řádků C-komentářů. Můžete použít komentáře, abyste nedali fragment kódu získat nebo jen pro záznam záznamů.

Kroky

Část 1 z 2:

Styly

jeden. Jednorázové komentáře pro krátké záznamy. Pokud potřebujete zanechat krátký komentář, použijte kód single-line komentáře. Komentář diktuje pouze na konci řádku nebo na konci kódového bloku. Takové komentáře pracují pouze uvnitř tagů PHP a budou čteny pouze v případě, že je vložíte do html.

// Jedná se o standardní (C ++) způsob, jak vytvořit jednorázový komentář. Pro vytvoření jednoho řádku komentáře. Můžete také použít tento styl UNIX ?>

2. Chcete-li psát dlouhé komentáře nebo testovací kód, použijte víceřádkové komentáře. Vícevrstvé komentáře jsou velmi užitečné při psaní dlouhých vysvětlení a zabránit zpracování segmentu kódů. Přečtěte si sekci "Použít" a dozvíte se o některých tipech na použití "Víceřadovací komentáře.

/ * To je to, jak to stojí za formátimnostrofivní komentář. Celá učebnice konce štítku bude obsahovat komentář * // * Někteří chtěli zapnout * na vrchol každého řádku * Další značky. Zlepší * čitelnost velkých komentářů, i když to není povinné. * /?>

Část 2 z 2:

Používání

jeden. Použijte komentáře pro opuštění poznámek pro efektivitu kódu. Nemusíte to udělat pro každý řádek kódu, protože ostatní programátoři mohou snadno zjistit v dobře psaným kódem. Komentáře jsou užitečné, pokud kód provádí nestandardní nebo ne zřejmé funkce.

// Vytvořit požadavek CURL $ Session = Curl_Init ($ požadavek) - // Řekni Curl použít http postcurl_setopt ($ relace, curlopt_post, true)-

2. Nechte komentáře nezapomenout, co jste udělali s kódem. Při práci na projektu vám komentáře nenechají zapomenout, co jste se zastavil. Nechte komentáře pro kód, který funguje nesprávně nebo jste ještě nedokončili.

// před pokračováním na další krok, musíte zkontrolovat výsledek tohoto programu: "Ahoj World!"-

3. Zanechat komentář pro kód, který plánujete sdílet. Pokud máte v plánu spolupracovat s jinými programátory, nebo bude váš kód veřejně dostupný, komentáře pomohou ostatním pochopit, jak váš kód funguje a co by mělo být opraveno.

/ * Existuje efektivnější způsob, jak to udělat?* / Rod: Pokud (ISSET ($ Gender) && $ gender == "žena") echo "zkontrolovat"-?> Value = "Žena"> Žena Pokud (ISSET ($ Gender) && $ Gender == "Male") echo "zkontrolovat"-?> Value = "Muž"> Muž

4. Nechte komentáře zrušit specifické kódové bloky. Je velmi užitečné, když testujete kód a chcete zastavit práci nějakého druhu fragmentu. Při spuštění stránky, vše, co je uvedeno v popisu komentáře, budou ignorovány.

Echo "/ * hello * / svět!"- / * Při zahájení výše uvedeného kódu se slovo" hello "neodráží * /?>

Pět. Buďte opatrní při komentování velkých bloků kódu. Funkce komentování ukončí, když první dokončení značka vydělá, takže pokud uvnitř kódu, na kterém jste již komentovali, je víceřádkový komentář, ukazuje se pouze před počátečním komentářem.

/ * Echo "Ahoj World!"- / * Tento komentář bude kazí * / * /?>

/ * Echo "Ahoj World!"- // s tímto komentářem, vše bude v pořádku * /?>

6. Použijte komentáře k vytvoření pseudo-rekordér. Můžete použít některé formáty kreativních kódů pro vytvoření záznamu pro kód přímo uvnitř IT. Je velmi užitečné pro veřejně dostupné projekty.

// ============ // Název // ======= // ------------- // Subtitle // ------------- / * Název sekce * / # záznamy Zde můžete psát # Druhá část může být napsána zde / * * Využijte toho, abyste to vysvětlili: Pro které potřebujete několik řádků * nebo dokonce několik bodů vysvětlení * /?>

Tipy

Komentáře HTML a PHP se liší od sebe, takže při práci s scénáře (kombinace HTML a PHP) se ujistěte, že používáte správnou syntaxi.
Například v dalším kódu je komentář HTML, ale stále provádí kód PHP. Pokud umístíte komentář HTML uvnitř značky PHP, bude to výsledkem.