Hur man gör kommentarer i PHP

Författare: Sara Rhodes
Skapelsedatum: 16 Februari 2021
Uppdatera Datum: 1 Juli 2024
Anonim
The Complete Guide to Google Forms - Online Survey and Data Collection Tool!
Video: The Complete Guide to Google Forms - Online Survey and Data Collection Tool!

Innehåll

En kommentar är en sorts anteckning som kan användas för att förklara syftet och innebörden av ett kodavsnitt. När du arbetar i PHP har du flera alternativ för att skriva kommentarer som har kommit från de gamla välkända programmeringsspråken: genom att skriva in en- eller flerradiga C-kommentarer. Du kan använda kommentarer för att hålla en kodbit från att fungera, eller bara för att hålla register.

Steg

Del 1 av 2: Stilar

  1. 1 Enradiga kommentarer för korta inlägg. Om du behöver lämna en kort kommentar, använd enradig kommentarkod. Kommentaren sträcker sig bara till slutet av en rad eller slutet av ett kodblock. Sådana kommentarer fungerar bara inom PHP -taggar och kommer bara att läsas om de placeras i HTML.

    ? php // Detta är standard (C ++) sätt att skapa en enda radkommentar # Du kan också använda den här Unix -stilen för att skapa en enda radkommentar?> var13 ->

  2. 2 Använd kommentarer med flera rader för att skriva långa kommentarer eller testkoder. Flerradiga kommentarer är mycket användbara för att skriva långa förklaringar och för att förhindra att ett segment av kod bearbetas. Läs avsnittet Användning för några tips om hur du använder kommentarer med flera rader.

    ? php / * Så här formaterar du en kommentar med flera rader. All text fram till slutet av taggen kommer att inkluderas i kommentaren * / / * Vissa människor gillar att inkludera * i början av varje rad * extra kulor. Detta kommer att förbättra * läsbarheten för stora kommentarer, även om det inte krävs. * /?> var13 ->

Del 2 av 2: Användning

  1. 1 Använd kommentarer för att lämna anteckningar om kodhälsa. Du behöver inte göra detta för varje kodrad, eftersom andra programmerare enkelt kan räkna ut välskriven kod. Kommentarer är användbara när din kod utför icke-standardiserade eller inte uppenbara funktioner.

    // Skapa en curl -begäran $ session = curl_init ($ request); // Berätta för curl att använda HTTP POST curl_setopt ($ session, CURLOPT_POST, true);

  2. 2 Lämna kommentarer så att du inte glömmer vad du gjorde med koden. När du arbetar med ett projekt kommer kommentarer att hindra dig från att glömma var du slutade. Lämna kommentarer för kod som inte fungerar korrekt eller som du inte är klar än.

    // Innan du går vidare till nästa steg, dubbelkolla utmatningen från detta programeko "Hello World!";

  3. 3 Lämna en kommentar för koden du planerar att dela. Om du planerar att samarbeta med andra programmerare eller kommer att göra din kod offentligt tillgänglig, kommer kommentarer att hjälpa andra att förstå hur din kod fungerar och vad som behöver åtgärdas.

    / * Finns det ett bättre sätt att uppnå detta? * / Kön: 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 "> Man

  4. 4 Lämna kommentarer för att ångra specifika kodblock. Detta är ganska användbart när du testar din kod och vill stoppa en del av den från att köras. Allt som ingår i kommentarsmärket ignoreras när sidan startar.

    ? php echo " / * Hej * / världen!"; / * När koden ovan körs kommer ordet "Hej" inte att reflekteras * /?> Var13 ->

  5. 5 Var försiktig när du kommenterar stora kodblock. Kommentarfunktionen kommer att avslutas när det första slutmärket är aktivt, så om det finns en flerradig kommentar inne i koden som du redan har kommenterat, kommer den bara att pågå till början av den ursprungliga kommentaren.

    ? php / * eko "Hej världen!"; / * Den här kommentaren kommer att förstöra allt * / * /?> Var13 ->

    ? php / * eko "Hej världen!"; // Den här kommentaren blir bra * /?> Var13 ->

  6. 6 Använd kommentarer för att skapa pseudoinspelningar. Du kan använda några kreativa kodformat för att skapa en kodpost direkt inuti den. Detta är ganska användbart för projekt med öppen källkod.

    ? php // ============= // HEADER // ============== // ------------ -// Undertext // ------------- / * Avsnittsnamn * / # Inlägg kan skrivas här # Den andra delen kan skrivas här / * * Använd detta för att förklara * varför skulle du behöva några rader * eller till och med några förklaringspunkter * /?> var13 ->

Tips

  • HTML- och PHP -kommentarer skiljer sig från varandra, så när du arbetar med skript (en kombination av HTML och PHP), se till att du använder rätt syntax.
  • Till exempel innehåller följande kod en HTML -kommentar, men den kör fortfarande PHP -koden. Om du lägger in en HTML -kommentar i en PHP -tagg kommer det att resultera i ett fel.
    • ! - div id = "exempel">? php echo ’hej’; ?> var13 -> / div> ->