Kuinka kommentoida PHP: ssä

Kirjoittaja: Sara Rhodes
Luomispäivä: 16 Helmikuu 2021
Päivityspäivä: 27 Kesäkuu 2024
Anonim
Kuinka kommentoida PHP: ssä - Yhteiskunta
Kuinka kommentoida PHP: ssä - Yhteiskunta

Sisältö

Kommentti on eräänlainen huomautus, jonka avulla voidaan selittää koodinpätkän tarkoitus ja merkitys. Kun työskentelet PHP: ssä, sinulla on useita vaihtoehtoja kirjoittaa kommentteja, jotka ovat peräisin vanhoilta tunnetuilta ohjelmointikieliltä: kirjoittamalla yksirivisiä tai monirivisiä C-kommentteja. Kommenttien avulla voit estää koodin toimimisen tai vain pitää kirjaa.

Askeleet

Osa 1/2: Tyylit

  1. 1 Yksiriviset kommentit lyhyille viesteille. Jos haluat jättää lyhyen kommentin, käytä yksirivistä kommenttikoodia. Kommentti ulottuu vain rivin loppuun tai koodilohkon loppuun. Tällaiset kommentit toimivat vain PHP -tunnisteissa, ja ne luetaan vain, jos ne on sijoitettu HTML -koodiin.

    ? php // Tämä on tavallinen (C ++) tapa luoda yksirivinen kommentti # Voit myös käyttää tätä Unix -tyyliä yksirivisen kommentin luomiseen?> var13 ->

  2. 2 Käytä monirivisiä kommentteja pitkien kommenttien tai testikoodin kirjoittamiseen. Moniriviset kommentit ovat erittäin hyödyllisiä kirjoittaessasi pitkiä selityksiä ja estääksesi koodin segmentin käsittelyn. Lue Käyttö-osiosta vinkkejä monirivisten kommenttien käyttämiseen.

    ? php / * Näin voit muotoilla monirivisen kommentin. Kaikki teksti tunnisteen loppuun asti sisältyy kommenttiin. Tämä parantaa suurten kommenttien luettavuutta, * vaikka sitä ei vaadita. * /?> var13 ->

Osa 2/2: Käyttö

  1. 1 Käytä kommentteja jättääksesi muistiinpanoja koodin kunnosta. Sinun ei tarvitse tehdä tätä jokaiselle koodiriville, koska muut ohjelmoijat voivat helposti selvittää hyvin kirjoitetun koodin. Kommentit ovat hyödyllisiä, kun koodisi suorittaa epätavallisia tai epäselviä toimintoja.

    // Luo curl -pyyntö $ session = curl_init ($ request); // Käske curl käyttää HTTP POST curl_setopt ($ session, CURLOPT_POST, true);

  2. 2 Jätä kommentteja, jotta et unohda mitä teit koodilla. Kun työskentelet projektin parissa, kommentit estävät sinua unohtamasta sitä, mihin jäit. Jätä kommentteja koodista, joka ei toimi oikein tai jota et ole vielä lopettanut.

    // Ennen kuin siirryt seuraavaan vaiheeseen, tarkista tämän ohjelman ulostulo "Hello World!";

  3. 3 Jätä kommentti koodille, jonka aiot jakaa. Jos aiot tehdä yhteistyötä muiden ohjelmoijien kanssa tai aiot asettaa koodisi julkisesti saataville, kommentit auttavat muita ymmärtämään, miten koodisi toimii ja mitä on korjattava.

    / * Onko olemassa parempi tapa tehdä tämä? * / Sukupuoli: input type = "radio" name = "gender"? Php if (isset ($ gender) && $ gender == "female") echo "check" ;?> value = "female"> Female input type = "radio" name = "gender"? php if (isset ($ gender) && $ gender == "male") echo "tarkistettu";?> value = "male "> Mies

  4. 4 Kommentoi tiettyjä koodilohkoja. Tämä on varsin hyödyllistä, kun testaat koodiasi ja haluat pysäyttää osan siitä. Kaikki kommenttimerkin sisältämät asiat ohitetaan sivun alkaessa.

    ? php echo " / * Hei * / Maailma!"; / * Kun yllä oleva koodi suoritetaan, sana "hei" ei näy * /?> Var13 ->

  5. 5 Ole varovainen kommentoidessasi suuria koodilohkoja. Kommentointitoiminto päättyy, kun ensimmäinen viimeistelymerkki on aktiivinen, joten jos jo kommentoimasi koodin sisällä on monirivinen kommentti, se kestää vain alkuperäisen kommentin alkuun.

    ? php / * echo "Hei maailma!"; / * Tämä kommentti pilaa kaiken * / * /?> Var13 ->

    ? php / * echo "Hei maailma!"; // Tämä kommentti on hyvä * /?> Var13 ->

  6. 6 Luo pseudotallenteita kommenteilla. Voit käyttää joitakin luovia koodimuotoja luodaksesi koodin suoraan sen sisälle. Tämä on melko hyödyllistä avoimen lähdekoodin projekteissa.

    ? php // ============= // HEADER // ============= // ------------ -// Tekstitys // ------------- / * Osion nimi * / # Merkinnät voidaan kirjoittaa tänne # Toinen osa voidaan kirjoittaa tänne / * * Käytä tätä selittääksesi * miksi tarvitset muutaman rivin * tai edes muutaman selityspisteen * /?> var13 ->

Vinkkejä

  • HTML- ja PHP -kommentit eroavat toisistaan, joten kun käytät skriptejä (HTML- ja PHP -yhdistelmä), varmista, että käytät oikeaa syntaksia.
  • Esimerkiksi seuraava koodi sisältää HTML -kommentin, mutta suorittaa silti PHP -koodin. Jos laitat HTML -kommentin PHP -tunnisteen sisälle, se johtaa virheeseen.
    • ! - div id = "example">? php echo ’hello’; ?> var13 -> / div> ->