Lägg till kommentarer i PHP: 7 steg (med bilder)

Steg
- Del 1 av 2: Stilar
- Del 2 av 2: Använd
Tips

Kommentarer inom ett programmeringsspråk är vissa anteckningar som kan användas för att klargöra syftet och avsikten med ett kodblock. När du använder PHP har du flera alternativ att välja mellan som härrör från allmänt använda, äldre programmeringsspråk med två val när det kommer till enradskommentarer och även ett flerradskommentarformulär, härlett från stilen som används i C. programmeringsspråk. Du kan använda kommentarer för att förhindra att kodblock körs, och du kan till och med använda dem för att skapa dokumentation.

Steg

Del 1 av 2: Stilar

1. Använd kommentarer på en rad för korta kommentarer. Om du vill skriva en kort kommentar kan du använda enradskoden för det. Denna kommentar går inte längre än till slutet av raden eller slutet av kodblocket. Denna typ av kommentar fungerar bara inom PHP-taggar och kommer att läsas om de placeras i HTML-kod.

1. Använd flerradskommentarer för mer omfattande kommentarer eller kodtestning. Flerradiga kommentarer är användbara för att skriva en längre förklaring eller för att förhindra att ett visst kodsegment körs. Läs delen "Användande" nedan för några tips om hur du använder flerradskommentarer.

Del 2 av 2: Använd

1. Använd kommentarer för att lämna kommentarer om hur koden fungerar. Det finns inget behov av att göra detta för varje rad kod eftersom välskriven kod är lätt för andra programmerare att förstå. Det är användbart om det finns ovanliga eller oklara funktioner i koden.

// Generera curl request $session = curl_init($request); // Säg till curl att använda HTTP POST curl_setopt ($session, CURLOPT_POST, true);

Lämna en kommentar så att du inte glömmer vad du gjorde. När du arbetar med dina egna projekt kan kommentarer hjälpa dig att komma ihåg var du slutade. Kommentera kod som inte fungerar, eller som du inte har slutfört än.

// Måste titta på detta innan jag fortsätter att eka "Hej världen!";

Kommentera koden du vill dela. Om du planerar att samarbeta med andra, eller vill göra koden öppen källkod, kan kommentarer hjälpa andra att ta reda på vad dina funktioner gör och var de kan förbättras.

/* Finns det ett mer effektivt sätt att göra detta? */ Sex:

Använd kommentarer för att förhindra att vissa kodblock körs. Detta är användbart om du vill testa något och förhindra att viss kod körs. Allt inom kommentarstaggarna kommer att ignoreras när webbsidan laddas.

2. Var försiktig när du kommenterar stora kodblock. Kommentarsfunktionen stoppas när den första sluttaggen signaleras, så om det redan finns en flerradskommentar i koden som du vill kommentera, kommer denna kommentar att stoppa i slutet av den kapslade kommentaren.

3. Använd kommentarer för att skapa pseudodokumentation. Du kan använda lite kreativ formatering för att skapa dokumentation för din kod direkt i koden. Detta kan vara användbart för projekt med öppen källkod.

Tips

HTML-kommentarer och PHP-kommentarer skiljer sig från varandra, så om du använder skript (en blandning av HTML och PHP), var noga med att inte blanda ihop kommentarskoderna.
Till exempel, i koden nedan, har den HTML-kommentarer, men PHP-kod exekveras fortfarande. Att placera HTML-kommentarer i PHP-taggar kommer att orsaka fel.