Sådan laver du kommentarer i PHP

Forfatter: Sara Rhodes
Oprettelsesdato: 16 Februar 2021
Opdateringsdato: 1 Juli 2024
Anonim
EVERYTHING IS SIMPLE AND BRIEF !!! 10 USEFUL TIPS FOR THE MASTER.
Video.: EVERYTHING IS SIMPLE AND BRIEF !!! 10 USEFUL TIPS FOR THE MASTER.

Indhold

En kommentar er en slags note, der kan bruges til at forklare formålet og betydningen af ​​et kodestykke. Når du arbejder i PHP, har du flere muligheder for at skrive kommentarer, der kommer fra de gamle velkendte programmeringssprog: ved at indtaste C-kommentarer med én eller flere linjer. Du kan bruge kommentarer til at forhindre et stykke kode i at fungere, eller bare til at holde optegnelser.

Trin

Del 1 af 2: Stilarter

  1. 1 Enkeltlinjekommentarer til korte indlæg. Hvis du har brug for at efterlade en kort kommentar, skal du bruge kommentarkoden på én linje. Kommentaren strækker sig kun til slutningen af ​​en linje eller slutningen af ​​en kodeblok. Sådanne kommentarer fungerer kun inden for PHP -tags og læses kun, hvis de placeres i HTML.

    ? php // Dette er standard (C ++) måde at oprette en enkelt linjekommentar # Du kan også bruge denne Unix -stil til at oprette en enkelt linjekommentar?> var13 ->

  2. 2 Brug kommentarer med flere linjer til at skrive lange kommentarer eller testkode. Kommentarer med flere linjer er meget nyttige til at skrive lange forklaringer og til at forhindre, at et segment af kode behandles. Læs afsnittet Anvendelse for at få nogle tip til brug af kommentarer med flere linjer.

    ? php / * Sådan formateres en kommentar med flere linjer. Al tekst op til slutningen af ​​tagget vil blive inkluderet i kommentaren * / / * Nogle mennesker kan lide at inkludere * i begyndelsen af ​​hver linje * ekstra punkter. Dette vil forbedre * læsbarheden af ​​store kommentarer, selvom det ikke er påkrævet. * /?> var13 ->

Del 2 af 2: Brug

  1. 1 Brug kommentarer til at efterlade noter om kodesundhed. Du behøver ikke at gøre dette for hver kodelinje, da andre programmører let kan finde ud af velskrevet kode. Kommentarer er nyttige, når din kode udfører ikke-standardiserede eller ikke indlysende funktioner.

    // Opret en curl -anmodning $ session = curl_init ($ request); // Fortæl curl at bruge HTTP POST curl_setopt ($ session, CURLOPT_POST, true);

  2. 2 Efterlad kommentarer, så du ikke glemmer, hvad du gjorde med koden. Når du arbejder på et projekt, forhindrer kommentarer dig i at glemme, hvor du slap. Efterlad kommentarer til kode, der ikke fungerer korrekt, eller som du ikke er færdig med endnu.

    // Inden du går videre til det næste trin, skal du dobbelttjekke output fra dette program ekko "Hej verden!";

  3. 3 Efterlad en kommentar til den kode, du planlægger at dele. Hvis du planlægger at samarbejde med andre programmører eller vil gøre din kode offentligt tilgængelig, vil kommentarer hjælpe andre med at forstå, hvordan din kode fungerer, og hvad der skal rettes.

    / * Er der en bedre måde at opnå dette på? * / Køn: input type = "radio" navn = "køn"? Php hvis (isset ($ gender) && $ gender == "female") ekko "kontrolleret" ;?> value = "female"> Female input type = "radio" name = "gender"? php if (isset ($ gender) && $ gender == "male") echo "Checked";?> value = "male "> Mand

  4. 4 Efterlad kommentarer for at fortryde bestemte kodeblokke. Dette er ganske nyttigt, når du tester din kode og vil stoppe et stykke af den fra at køre. Alt, der er inkluderet i kommentarfeltet, ignoreres, når siden starter.

    ? php echo " / * Hej * / Verden!"; / * Når ovenstående kode køres, vil ordet "Hej" ikke blive afspejlet * /?> Var13 ->

  5. 5 Vær forsigtig, når du kommenterer store kodeblokke. Kommentarfunktionen slutter, når det første færdiggørelsesmærke er aktivt, så hvis der er en flerlinjes kommentar inde i koden, som du allerede har kommenteret, varer den kun indtil begyndelsen af ​​den originale kommentar.

    ? php / * ekko "Hej verden!"; / * Denne kommentar vil ødelægge alt * / * /?> Var13 ->

    ? php / * ekko "Hej verden!"; // Denne kommentar vil være fin * /?> Var13 ->

  6. 6 Brug kommentarer til at oprette pseudo -optagelser. Du kan bruge nogle kreative kodeformater til at oprette en kodeindgang lige inde i den. Dette er ret nyttigt til open source -projekter.

    ? php // ============= // HEADER // ============== // // ------------ -// Undertekst // ------------- / * Sektionsnavn * / # Indlæg kan skrives her # Anden del kan skrives her / * * Brug dette til at forklare * hvorfor skulle du bruge et par linjer * eller endda et par forklaringspunkter * /?> var13 ->

Tips

  • HTML- og PHP -kommentarer er forskellige fra hinanden, så når du arbejder med scripts (en kombination af HTML og PHP), skal du sørge for at bruge den korrekte syntaks.
  • For eksempel indeholder følgende kode en HTML -kommentar, men den udfører stadig PHP -koden. Hvis du lægger en HTML -kommentar inde i et PHP -tag, vil det resultere i en fejl.
    • ! - div id = "eksempel">? php echo ’hej’; ?> var13 -> / div> ->