PHP Kommenterer Standards

PHP er en åpen kildekode HTML skriptspråk, koden som drives av PHP tolk. Kommentarer blir behandlet som tomrom og ignorert PHP tolk når det kompilerer og kjører koden. Programmerere legge kommentere linjer å kode slik at andre vet den tiltenkte funksjonen til hver del av koden. Kommentarer er også en standard metode for å feilsøke kode.

programvare Kode

Å plassere en hash eller nummertegn ved starten av en linje som forårsaker PHP tolk for å ignorere all tekst etter den. Plassere to høyrevendte skråstreker - // - etter en kodelinje skaper en inline kode kommentar. All tekst etter at to høyrevendte skråstreker på denne linjen ignoreres av PHP tolk. PHP tolk vil hoppe til neste linje etter kjørbar kode. En multi-linje kommentar blokk er betegnet med / ... /. Den multi-line kommentar krever ikke ekstra identifikatorer til sin ende preget av følgende: * /. Enhver PHP-kode inne i multi-line kommentar blokken vil ikke bli behandlet. Det er ingen standard på lengden eller antall single kommentar linjer eller flere linjer kommentar blokker som brukes i PHP-koden.

kommenterer Standards

Kommentarer skal beskrive den tiltenkte funksjon av koden. Kommentarer skal gi en høy grad forklaring av den logikk som brukes. Kommentarer kan forklare manipulering av variabler eller data hentet kalt av koden. Legge blanke linjer før kommentere linjer skiller den visuelt fra koden, som gjør det enklere for programmerere å finne og lese. Legge til et mellomrom før den første bokstaven etter den doble skråstreker forbedrer lesbarheten. Sette inn en tom kommentar linje etter en blokk med kommentarer er valgfritt.

Feilsøking

Kommenterer linjer fjerner dem fra kjørbar logikk. Kommenterer ut linjer med kode påpekt som mulige årsaker til problemer lar programmerere å identifisere spesifikk kode generere feilen. Programvareutviklere bør kommentere ut en mistanke om delen og kjør transaksjonen. Hvis feilen oppstår på nytt, programmerere fjerne kommenterer fra de testede linjer og kommentere ut neste mistenkt sett med kode. Denne prosessen gjentas inntil feilen ikke oppstår på nytt. Den kommentert koden er da fast, kommentering merkene fjernet, og den faste koden er testet.

Drupal Kommentarer

Drupal bruker PHP-filer for Web sidemaler. PHP-kode filene slutter i php. Drupal kommentar mal kalles comment.tpl.php. Comment.tpl.php gir en standard mal for behandling av kommentarer på nettsider. PHP kommenterer malen inneholder kode for å inkludere HTML-koblinger i kommentarer og digitale signaturer. Redigere maler i Drupal er gjort i PHP. Webutviklere som bruker Drupal kan referere PHP maler for standardhandlinger som e-post generasjon.