Tilføj kommentarer i PHP: 7 trin (med billeder)

Indhold

Trin
- Del 1 af 2: Stilarter
- Del 2 af 2: Brug
Tips

Kommentarer inden for et programmeringssprog er visse bemærkninger, der kan bruges til at afklare formålet og hensigten med en kodeblok. Når du bruger PHP, har du flere muligheder at vælge imellem, der stammer fra udbredte, ældre programmeringssprog med to valgmuligheder, når det kommer til enkeltlinjekommentarer og også en flerlinjet kommentarformular, afledt af stilen brugt i C. programmeringssprog. Du kan bruge kommentarer til at forhindre kodeblokke i at udføre, og du kan endda bruge dem til at generere dokumentation.

Trin

Del 1 af 2: Stilarter

1. Brug en-linje kommentarer til korte kommentarer. Hvis du vil skrive en kort kommentar, kan du bruge koden på én linje til det. Denne kommentar går ikke ud over slutningen af linjen eller slutningen af kodeblokken. Denne type kommentar virker kun i PHP-tags og vil blive læst, hvis den placeres i HTML-kode.

1. Brug multiline kommentarer til mere omfattende kommentarer eller kodetest. Kommentarer med flere linjer er nyttige til at skrive en længere forklaring eller til at forhindre et bestemt kodesegment i at udføres. Læs delen "Brug" nedenfor for nogle tips om brug af multi-line kommentarer.

Del 2 af 2: Brug

1. Brug kommentarer til at skrive kommentarer om, hvordan koden fungerer. Det er ikke nødvendigt at gøre dette for hver linje kode, da velskrevet kode er let for andre programmører at forstå. Det er nyttigt, hvis der er usædvanlige eller uklare funktioner i koden.

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

Efterlad en kommentar, så du ikke glemmer, hvad du gjorde. Når du arbejder på dine egne projekter, kan kommentarer hjælpe dig med at huske, hvor du slap. Kommenter kode, der ikke virker, eller som du ikke har udfyldt endnu.

// Skal se på dette, før jeg fortsætter med at ekko "Hej Verden!";

Kommenter koden du vil dele. Hvis du planlægger at samarbejde med andre eller ønsker at gøre koden open source, kan kommentarer hjælpe andre med at finde ud af, hvad dine funktioner gør, og hvor de kan forbedres.

/* Er der en mere effektiv måde at gøre dette på? */ Køn:

Brug kommentarer til at forhindre visse kodeblokke i at køre. Dette er nyttigt, hvis du vil teste noget og forhindre bestemt kode i at blive kørt. Alt i kommentarmærkerne vil blive ignoreret under indlæsning af websiden.

2. Vær forsigtig, når du kommenterer store kodeblokke. Kommentarfunktionen stopper, når det første slutmærke signaleres, så hvis der allerede er en flerlinjekommentar i koden, som du vil kommentere, stopper denne kommentar i slutningen af den indlejrede kommentar.

3. Brug kommentarer til at oprette pseudodokumentation. Du kan bruge noget kreativ formatering til at oprette dokumentation for din kode direkte i koden. Dette kan være nyttigt til open source-projekter.

Tips

HTML-kommentarer og PHP-kommentarer er forskellige, så hvis du bruger scripting (en blanding af HTML og PHP), skal du passe på ikke at forveksle kommentarkoderne.
For eksempel, i koden nedenfor, har den HTML-kommentarer, men PHP-kode udføres stadig. Anbringelse af HTML-kommentarer inde i PHP-tags vil forårsage fejl.