Kaip komentuoti PHP

Autorius: Sara Rhodes
Kūrybos Data: 16 Vasario Mėn 2021
Atnaujinimo Data: 1 Liepos Mėn 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

Turinys

Komentaras yra savotiška pastaba, kuria galima paaiškinti kodo fragmento tikslą ir prasmę. Dirbdami PHP, turėsite keletą variantų, kaip rašyti komentarus iš senų žinomų programavimo kalbų: įvesdami vienos eilutės arba kelių eilučių C komentarus. Galite naudoti komentarus, kad neveiktų kodo dalis, arba tiesiog įrašai.

Žingsniai

1 dalis iš 2: Stiliai

  1. 1 Vienos eilutės komentarai trumpiems įrašams. Jei norite palikti trumpą komentarą, naudokite vienos eilutės komentaro kodą. Komentaras bus tęsiamas tik iki eilutės pabaigos arba kodo bloko pabaigos. Tokie komentarai veikia tik PHP žymose ir bus skaitomi tik įdėjus juos į HTML.

    ? php // Tai yra standartinis (C ++) vienos eilutės komentaro kūrimo būdas # Taip pat galite naudoti šį Unix stilių, kad sukurtumėte vienos eilutės komentarą?> var13 ->

  2. 2 Naudokite kelių eilučių komentarus, kad rašytumėte ilgus komentarus arba bandymo kodą. Kelių eilučių komentarai yra labai naudingi rašant ilgus paaiškinimus ir neleidžiant apdoroti kodo segmento. Perskaitykite skyrių Naudojimas, kad gautumėte patarimų, kaip naudoti kelių eilučių komentarus.

    ? php / * Štai kaip suformatuoti kelių eilučių komentarą. Visas tekstas iki žymos pabaigos bus įtrauktas į komentarą * / / * Kai kurie žmonės mėgsta įtraukti * * kiekvienos eilutės pradžioje. Tai pagerins didelių komentarų skaitomumą, * nors tai nėra būtina. * /?> var13 ->

2 dalis iš 2: Naudojimas

  1. 1 Naudokite komentarus, kad paliktumėte pastabas apie kodo būklę. Jūs neturite to daryti kiekvienai kodo eilutei, nes kiti programuotojai gali lengvai išsiaiškinti gerai parašytą kodą. Komentarai yra naudingi, kai jūsų kodas atlieka nestandartines ar ne akivaizdžias funkcijas.

    // Sukurti garbanos užklausą $ session = curl_init ($ request); // Nurodykite curl naudoti HTTP POST curl_setopt ($ session, CURLOPT_POST, true);

  2. 2 Palikite komentarus, kad nepamirštumėte, ką padarėte su kodu. Dirbdami prie projekto, komentarai neleis pamiršti to, kur baigėte. Palikite komentarus dėl netinkamai veikiančio arba dar nebaigto kodo.

    // Prieš pereidami prie kito žingsnio, dar kartą patikrinkite šios programos išvestį aidas "Labas pasaulis!";

  3. 3 Palikite komentarą apie kodą, kurį ketinate bendrinti. Jei planuojate bendradarbiauti su kitais programuotojais arba ketinate viešai paskelbti savo kodą, komentarai padės kitiems suprasti, kaip jūsų kodas veikia ir ką reikia pataisyti.

    / * Ar yra geresnis būdas tai padaryti? * / Lytis: input type = "radio" name = "gender"? Php if (isset ($ gender) && $ gender == "female") echo "check" ;?> value = "female"> Moteris "> Vyras

  4. 4 Palikite komentarus, kad anuliuotumėte konkrečius kodo blokus. Tai labai naudinga, kai bandote kodą ir norite sustabdyti jo veikimą. Viskas, kas įtraukta į komentaro ženklą, bus ignoruojama, kai puslapis pradės veikti.

    ? php echo " / * Sveiki * / Pasaulis!"; / * Kai bus paleistas aukščiau pateiktas kodas, žodis „Labas“ nebus atspindėtas * /?> Var13 ->

  5. 5 Būkite atsargūs komentuodami didelius kodo blokus. Komentavimo funkcija baigsis, kai bus aktyvus pirmasis užbaigimo ženklas, taigi, jei jūsų jau komentuoto kodo viduje yra kelių eilučių komentaras, jis tęsis tik iki pradinio komentaro pradžios.

    ? php / * echo "Labas pasaulis!"; / * Šis komentaras viską sugadins * / * /?> Var13 ->

    ? php / * echo "Labas pasaulis!"; // Šis komentaras bus geras * /?> Var13 ->

  6. 6 Naudokite komentarus, kad sukurtumėte pseudo įrašus. Galite naudoti kai kuriuos kūrybinio kodo formatus, kad sukurtumėte kodo įrašą tiesiai jo viduje. Tai gana naudinga atviro kodo projektams.

    ? php // ============= // HEADER // ============= // ------------ -// Subtitrai // ------------- / * Skilties pavadinimas * / # Čia galima įrašyti įrašus # Antrąją dalį galima parašyti čia / * * Naudokite tai paaiškinti * kodėl jums reikia kelių eilučių * ar net kelių paaiškinimų * /?> var13 ->

Patarimai

  • HTML ir PHP komentarai skiriasi vienas nuo kito, todėl dirbdami su scenarijais (HTML ir PHP deriniu) įsitikinkite, kad naudojate teisingą sintaksę.
  • Pavyzdžiui, šiame kode yra HTML komentaras, tačiau jis vis tiek vykdo PHP kodą. Jei įdėsite HTML komentarą į PHP žymą, atsiras klaida.
    • ! - div id = "example">? php echo ’hello’; ?> var13 -> / div> ->