Ako písať komentáre v PHP

Autor: Sara Rhodes
Dátum Stvorenia: 16 Február 2021
Dátum Aktualizácie: 27 V Júni 2024
Anonim
Ako písať komentáre v PHP - Spoločnosť
Ako písať komentáre v PHP - Spoločnosť

Obsah

Komentár je druh poznámky, ktorá sa dá použiť na vysvetlenie účelu a významu útržku kódu. Pri práci v PHP budete mať niekoľko možností na písanie komentárov, ktoré pochádzajú zo starých známych programovacích jazykov: zadaním jednoriadkových alebo viacriadkových komentárov jazyka C. Komentáre môžete použiť na to, aby časť kódu nefungovala, alebo len na uchovávanie záznamov.

Kroky

Časť 1 z 2: Štýly

  1. 1 Jednoriadkové komentáre pre krátke príspevky. Ak potrebujete zanechať krátky komentár, použite jednoriadkový kód komentára. Komentár sa bude vzťahovať iba na koniec riadka alebo na koniec bloku kódu. Takéto komentáre fungujú iba v rámci značiek PHP a budú sa čítať iba vtedy, ak budú umiestnené v HTML.

    ? php // Toto je štandardný (C ++) spôsob vytvárania jednoriadkového komentára # Tento unixový štýl môžete použiť aj na vytvorenie jednoriadkového komentára?> var13 ->

  2. 2 Na písanie dlhých komentárov alebo testovacích kódov použite viacriadkové komentáre. Viacriadkové komentáre sú veľmi užitočné pri písaní dlhých vysvetlení a pri predchádzaní spracovaniu segmentu kódu. V časti Použitie nájdete niekoľko tipov na používanie viacriadkových komentárov.

    ? php / * Takto naformátujete viacriadkový komentár. Do komentára bude zahrnutý všetok text až do konca značky * / / * Niektorí ľudia radi zahrnú * na začiatok každého riadka * ďalšie odrážky. To zlepší čitateľnosť * veľkých komentárov, aj keď to nie je potrebné. * /?> var13 ->

Časť 2 z 2: Používanie

  1. 1 Pomocou komentárov môžete zanechať poznámky o stave kódu. Nemusíte to robiť pre každý riadok kódu, pretože ostatní programátori môžu ľahko zistiť dobre napísaný kód. Komentáre sú užitočné vtedy, keď váš kód vykonáva neštandardné alebo nie zrejmé funkcie.

    // Vytvorenie požiadavky na zvinutie $ session = curl_init ($ požiadavka); // Povedzte curl, aby používal HTTP POST curl_setopt ($ session, CURLOPT_POST, true);

  2. 2 Zanechajte komentáre, aby ste nezabudli, čo ste urobili s kódom. Pri práci na projekte vám pripomienky nezabudnú, kde ste skončili. Napíšte komentáre ku kódu, ktorý nefunguje správne alebo ktorý ste ešte nedokončili.

    // Predtým, ako prejdete k ďalšiemu kroku, dvakrát skontrolujte výstup tohto echa programu „Hello World!“;

  3. 3 Zanechajte komentár ku kódu, ktorý plánujete zdieľať. Ak plánujete spolupracovať s inými programátormi alebo sa chystáte svoj kód zverejniť, komentáre pomôžu ostatným porozumieť tomu, ako váš kód funguje a čo je potrebné opraviť.

    / * Existuje lepší spôsob, ako to dosiahnuť? * / Gender: input type = "radio" name = "gender"? PHP if (isset ($ gender) && $ gender == "female") echo "checked" ;?> value = "female"> Female input type = "radio" name = "gender"? php if (isset ($ gender) && $ gender == "male") echo "checked";?> value = "male "> Muž

  4. 4 Zanechajte komentáre a vráťte späť konkrétne bloky kódu. To je veľmi užitočné, keď testujete svoj kód a chcete zabrániť spusteniu jeho časti. Všetko, čo je súčasťou značky komentárov, bude pri spustení stránky ignorované.

    ? php echo " / * Ahoj * / Svet!"; / * Po spustení vyššie uvedeného kódu sa slovo „Dobrý deň“ nezobrazí * /?> Var13 ->

  5. 5 Pri komentovaní veľkých blokov kódu buďte opatrní. Funkcia komentovania sa skončí, keď je aktívna prvá značka dokončenia, takže ak je v kóde viacriadkový komentár, ktorý ste už komentovali, bude trvať iba do začiatku pôvodného komentára.

    ? php / * echo „Hello World!“; / * Tento komentár zničí všetko * / * /?> Var13 ->

    ? php / * echo „Hello World!“; // Tento komentár bude v poriadku * /?> Var13 ->

  6. 6 Pomocou komentárov vytvorte pseudo nahrávky. Niektoré formáty kódu kreatívy môžete použiť na vytvorenie záznamu kódu priamo v ňom. To je veľmi užitočné pre projekty s otvoreným zdrojovým kódom.

    ? php // ============== // HEADER // =============== // ------------ -// Podnázov // ------------- / * Názov sekcie * / # Sem je možné zapísať položky # Tu môžete napísať druhú časť / * * Použite na vysvetlenie * prečo by ste potrebovali niekoľko riadkov * alebo dokonca niekoľko bodov vysvetlenia * /?> var13 ->

Tipy

  • Komentáre HTML a PHP sa navzájom líšia, preto pri práci so skriptmi (kombinácia HTML a PHP) používajte správnu syntax.
  • Nasledujúci kód napríklad obsahuje komentár HTML, ale stále vykonáva kód PHP. Ak do značky PHP vložíte komentár HTML, bude to mať za následok chybu.
    • ! - div id = "example">? php echo ‘ahoj’; ?> var13 -> / div> ->