Ako urobiť komentáre k PHP: 3 kroky

Komentár je typ poznámky, ktorá môže byť použitá na vysvetlenie účelu a hodnôt fragmentu kódu. Práca v PHP, budete mať niekoľko možností na písanie komentárov, ktoré prešli zo starých známych programovacích jazykov: zadaním jednorazových alebo multi-line c-komentáre. Komentáre môžete použiť, aby ste nedali fragment kódu zarobiť alebo len na nahrávanie záznamov.

Kroky

Časť 1 z 2:

Štýly

jeden. Jedno-line komentáre pre krátke záznamy. Ak potrebujete zanechať krátku komentár, použite kód s jedným riadkom. Komentár diktuje len na koniec riadku alebo na konci kódu bloku. Takéto komentáre fungujú len vo vnútri značiek PHP a budú si prečítať len vtedy, ak ich umiestnite do html.

// Toto je štandardný (C ++) spôsob, ako vytvoriť jedno-line komentár. Ak chcete vytvoriť jedno-line komentár. Môžete tiež použiť tento štýl Unix ?>

2. Ak chcete napísať dlhé komentáre alebo testovací kód, používajte viac-line komentáre. Multi-line komentáre sú veľmi užitočné pri písaní dlhých vysvetlení a zabrániť spracovaniu segmentu kódu. Prečítajte si časť "Použite", aby ste sa dozvedeli o niektorých tipoch na použitie "Multi-Line Comments.

/ * Toto je, ako to stojí za to formátmimnostrofive komentár. Celá učebnica konca etikety bude obsahovať komentár * // * Niektoré, ako sa má zapnúť * na vrchol každého riadku * Ďalšie markery. Zlepší sa * čitateľnosť veľkých komentárov, hoci to nie je povinné. * /?>

Časť 2 z 2:

Spotreba

jeden. Použite komentáre na opustenie poznámok pre účinnosť kódu. Nemusíte to urobiť pre každý riadok kódu, pretože iní programátori môžu ľahko zistiť v dobre napísanom kóde. Komentáre sú užitočné, ak kód vykonáva neštandardné alebo nie sú zrejmé funkcie.

// Vytvorte žiadosť Curl $ Session = Curl_init ($ Requesional) - // Povedzte Curl na použitie http postcurl_setopt ($ ression, curlopt_post, true)-

2. Zanechajte komentáre nezabudnúť, čo ste urobili s kódom. Pri práci na projekte, Komentáre vám nenechajú zabudnúť, čo ste zastavili. Zanechať komentáre kódu, ktorý funguje nesprávne, alebo ste ešte neskončili.

// Pred pokračovaním do ďalšieho kroku, musíte skontrolovať výsledok tohto programu "Ahoj svet!"-

3. Zanechajte komentár pre kód, ktorý plánujete zdieľať. Ak plánujete spolupracovať s inými programátormi, alebo budete robiť svoj kód verejne dostupný, komentáre pomôžu ostatným pochopiť, ako váš kód funguje a čo by malo byť opravené.

/ * Existuje efektívnejší spôsob, ako to urobiť?* / Rod: Ak (Isset (C) && $ Gender =="Žena") Echo "Skontrolovať"-?> Hodnota ="Žena"> Žena Ak (Isset (C) && $ Gender =="Muž") Echo "Skontrolovať"-?> Hodnota ="Muž"> Muž

4. Nechajte pripomienky zrušiť špecifické kódové bloky. Je to celkom užitočné, keď testujete kód a chcete zastaviť prácu nejakého druhu fragmentu. Pri spustení stránky sa všetko, čo je zahrnuté v štítku komentár.

Echo "/ * Ahoj * / svet!"-/ * Pri spustení vyššie uvedeného kódu sa slovo "ahoj" neodráža * /?>

päť. Buďte opatrní pri komentovaní veľkých blokov kódu. Funkcia komentárstva skončí, keď prvá značka dokončenia zarobí, takže ak vo vnútri kódu, ktorý ste už komentovali, je multi-line komentár, ukazuje sa len pred počiatočným komentárom.

/ * Echo "Ahoj svet!"- / * Tento komentár bude pokaziť * / * /?>

/ * Echo "Ahoj svet!"- // s týmto komentárom bude všetko v poriadku * /?>

6. Použite komentáre na vytvorenie pseudo-rekordéra. Môžete použiť niektoré formáty kódy kódy na vytvorenie záznamu pre kód priamo vo vnútri. Je to veľmi užitočné pre verejne dostupné projekty.

// =========================================================================== //------------ // Titulky // ------------- / * Názov sekcie * / # Záznamy Tu môžete písať # Druhá časť je možné písať tu / * * Využite to, aby ste to vysvetliili: pre ktoré potrebujete niekoľko riadkov * alebo dokonca niekoľko bodov vysvetlenia * /?>

Tipy

Komentáre HTML a PHP sa od seba líšia, takže pri práci s scenármi (kombinácia HTML a PHP) sa uistite, že používate správnu syntax.
Napríklad v nasledujúcom kóde je komentár HTML, ale stále vykonáva PHP kód. Ak umiestnite komentár HTML vo vnútri PHP tag, bude to mať za následok.