Legg til kommentarer i PHP: 7 trinn (med bilder)

Innhold

Trinn
- Del 1 av 2: Stiler
- Del 2 av 2: Bruk
Tips

Kommentarer innenfor et programmeringsspråk er visse merknader som kan brukes til å klargjøre formålet og hensikten med en kodeblokk. Når du bruker PHP, har du flere alternativer å velge mellom som stammer fra mye brukte, eldre programmeringsspråk med to valg når det kommer til enkeltlinjers kommentarer og også et flerlinjes kommentarskjema, avledet fra stilen som brukes i C. programmeringsspråk. Du kan bruke kommentarer for å hindre kodeblokker i å kjøre, og du kan til og med bruke dem til å generere dokumentasjon.

Trinn

Del 1 av 2: Stiler

1. Bruk en-linjes kommentarer for korte kommentarer. Hvis du vil legge inn en kort kommentar, kan du bruke enlinjekoden for det. Denne kommentaren går ikke lenger enn slutten av linjen eller slutten av kodeblokken. Denne typen kommentarer fungerer bare innenfor PHP-tagger og vil bli lest hvis de plasseres i HTML-kode.

1. Bruk flerlinjekommentarer for mer omfattende kommentarer eller kodetesting. Flerlinjekommentarer er nyttige for å skrive en lengre forklaring, eller for å forhindre at et bestemt kodesegment kjøres. Les delen "Bruk" nedenfor for noen tips om bruk av flerlinjekommentarer.

Del 2 av 2: Bruk

1. Bruk kommentarer til å legge igjen kommentarer om hvordan koden fungerer. Det er ikke nødvendig å gjøre dette for hver linje med kode, da velskrevet kode er lett for andre programmerere å forstå. Det er nyttig hvis det er uvanlige eller uklare funksjoner i koden.

// Generer krølleforespørsel $session = curl_init($request); // Fortell curl å bruke HTTP POST curl_setopt ($session, CURLOPT_POST, true);

Legg igjen en kommentar så du ikke glemmer hva du gjorde. Når du jobber med dine egne prosjekter, kan kommentarer hjelpe deg med å huske hvor du slapp. Kommenter kode som ikke fungerer, eller som du ikke har fullført ennå.

// Må se på dette før jeg fortsetter å ekko "Hei Verden!";

Kommenter koden du vil dele. Hvis du planlegger å samarbeide med andre, eller ønsker å gjøre koden åpen kildekode, kan kommentarer hjelpe andre med å finne ut hva funksjonene dine gjør og hvor de kan forbedres.

/* Finnes det en mer effektiv måte å gjøre dette på? */ Sex:

Bruk kommentarer for å forhindre at visse blokker med kode kjøres. Dette er nyttig hvis du vil teste noe og forhindre at bestemt kode kjøres. Alt i kommentartaggene vil bli ignorert mens nettsiden lastes inn.

2. Vær forsiktig når du kommenterer store blokker med kode. Kommentarfunksjonen stopper når den første sluttkoden signaliseres, så hvis det allerede er en flerlinjekommentar i koden som du vil kommentere, vil denne kommentaren stoppe på slutten av den nestede kommentaren.

3. Bruk kommentarer til å lage pseudodokumentasjon. Du kan bruke litt kreativ formatering for å lage dokumentasjon for koden din rett i koden. Dette kan være nyttig for åpen kildekode-prosjekter.

Tips

HTML-kommentarer og PHP-kommentarer er forskjellige fra hverandre, så hvis du bruker skripting (en blanding av HTML og PHP), vær forsiktig så du ikke forveksler kommentarkodene.
For eksempel, i koden nedenfor, har den HTML-kommentarer, men PHP-koden kjøres fortsatt. Plassering av HTML-kommentarer i PHP-tagger vil forårsake feil.