Kā komentēt PHP

Autors: Sara Rhodes
Radīšanas Datums: 16 Februāris 2021
Atjaunināšanas Datums: 1 Jūlijs 2024
Anonim
5: How to Write Comments in PHP | PHP Tutorial | Learn PHP Programming | PHP for Beginners
Video: 5: How to Write Comments in PHP | PHP Tutorial | Learn PHP Programming | PHP for Beginners

Saturs

Komentārs ir sava veida piezīme, ko var izmantot, lai izskaidrotu koda fragmenta mērķi un nozīmi. Strādājot PHP, jums būs vairākas iespējas rakstīt komentārus, kas nākuši no vecajām labi zināmajām programmēšanas valodām: ievadot vienas rindas vai vairāku rindu C komentārus. Varat izmantot komentārus, lai koda daļa nedarbotos, vai vienkārši, lai saglabātu ierakstus.

Soļi

1. daļa no 2: Stili

  1. 1 Vienas rindas komentāri īsām ziņām. Ja jums ir jāatstāj īss komentārs, izmantojiet vienas rindas komentāra kodu. Komentārs attiecas tikai uz rindas beigām vai koda bloka beigām. Šādi komentāri darbojas tikai PHP tagos un tiks lasīti tikai tad, ja tie būs ievietoti HTML.

    ? php // Šis ir standarta (C ++) veids, kā izveidot vienas rindas komentāru # Varat arī izmantot šo Unix stilu, lai izveidotu vienas rindas komentāru?> var13 ->

  2. 2 Izmantojiet vairāku rindu komentārus, lai rakstītu garus komentārus vai testa kodu. Vairāku rindu komentāri ir ļoti noderīgi, lai rakstītu garus paskaidrojumus un novērstu koda segmenta apstrādi. Izlasiet sadaļu Lietošana, lai iegūtu dažus padomus par vairāku rindu komentāru izmantošanu.

    ? php / * Lūk, kā formatēt vairāku rindu komentāru. Viss teksts līdz taga beigām tiks iekļauts komentārā * / / * Dažiem cilvēkiem patīk katras rindas sākumā iekļaut * papildu aizzīmes. Tas uzlabos lielu komentāru lasāmību, * lai gan tas nav obligāti. * /?> var13 ->

2. daļa no 2: izmantošana

  1. 1 Izmantojiet komentārus, lai atstātu piezīmes par koda stāvokli. Jums tas nav jādara katrai koda rindai, jo citi programmētāji var viegli izdomāt labi uzrakstītu kodu. Komentāri ir noderīgi, ja jūsu kods veic nestandarta vai nepārprotamas funkcijas.

    // Izveidot čokurošanās pieprasījumu $ session = curl_init ($ request); // Pasakiet curl, lai izmantotu HTTP POST curl_setopt ($ session, CURLOPT_POST, true);

  2. 2 Atstājiet komentārus, lai neaizmirstu, ko darījāt ar kodu. Strādājot pie projekta, komentāri neļaus aizmirst to, kur beidzāt. Atstājiet komentārus par kodu, kas nedarbojas pareizi vai kuru vēl neesat pabeidzis.

    // Pirms pāriet uz nākamo soli, vēlreiz pārbaudiet šīs programmas izvadi atbalss "Hello World!";

  3. 3 Atstājiet komentāru par kodu, kuru plānojat kopīgot. Ja plānojat sadarboties ar citiem programmētājiem vai padarīsit savu kodu publiski pieejamu, komentāri palīdzēs citiem saprast, kā jūsu kods darbojas un kas ir jālabo.

    / * Vai ir kāds labāks veids, kā to paveikt? * / Dzimums: input type = "radio" name = "gender"? Php if (isset ($ gender) && $ gender == "female") echo "check" ;?> value = "female"> Sievietes ievades veids = "radio" name = "gender"? php if (isset ($ gender) && $ gender == "male") echo "check";?> value = "male "> Vīrietis

  4. 4 Atstājiet komentārus, lai atsauktu noteiktus koda blokus. Tas ir ļoti noderīgi, ja testējat savu kodu un vēlaties pārtraukt tā darbības sākšanu. Viss, kas ir iekļauts komentāra atzīmē, tiks ignorēts lapas sākumā.

    ? php echo " / * Sveiki * / Pasaule!"; / * Palaižot iepriekš minēto kodu, vārds "Sveiki" netiks atspoguļots * /?> Var13 ->

  5. 5 Esiet piesardzīgs, komentējot lielus koda blokus. Komentēšanas funkcija beigsies, kad būs aktīva pirmā pabeigšanas atzīme, tādēļ, ja jau komentētā koda iekšpusē ir daudzrindu komentārs, tas ilgs tikai līdz sākotnējā komentāra sākumam.

    ? php / * echo "Sveika pasaule!"; / * Šis komentārs sabojās visu * / * /?> Var13 ->

    ? php / * echo "Sveika pasaule!"; // Šis komentārs būs labs * /?> Var13 ->

  6. 6 Izmantojiet komentārus, lai izveidotu pseido ierakstus. Varat izmantot dažus radošā koda formātus, lai tieši tajā izveidotu koda ierakstu. Tas ir diezgan noderīgi atvērtā koda projektiem.

    ? php // ============= // HEADER // ============= // ------------ -// Apakšvirsraksts // ------------- / * Sadaļas nosaukums * / # Ierakstus var ierakstīt šeit # Otro daļu var ierakstīt šeit / * * Izmantojiet šo, lai izskaidrotu * kāpēc jums vajadzīgas dažas rindiņas * vai pat daži paskaidrojuma punkti * /?> var13 ->

Padomi

  • HTML un PHP komentāri atšķiras viens no otra, tāpēc, strādājot ar skriptiem (HTML un PHP kombinācija), noteikti izmantojiet pareizo sintaksi.
  • Piemēram, šajā kodā ir HTML komentārs, taču tas joprojām izpilda PHP kodu. Ja PHP tagā ievietojat HTML komentāru, tas radīs kļūdu.
    • ! - div id = "example">? php echo ’hello’; ?> var13 -> / div> ->