Kako da komentarišete PHP: 3 koraka

Komentar je vrsta napomena koja se može koristiti za objašnjenje svrhe i vrijednosti fragmenta koda. Radeći u PHP-u, imat ćete nekoliko opcija za pisanje komentara koje su prolazile sa stare dobro poznatog programiranja: unošenjem jednoredalnih ili višenamjenskih C-komentara. Možete koristiti komentare kako ne biste dali fragment kodeksa da biste zaradili ili samo za snimanje evidencija.

Korake

Dio 1 od 2:

Stilovi

jedan. Jednoznačni komentari za kratke zapise. Ako trebate ostaviti kratak komentar, koristite jednoredni kôd komentare. Komentar diktira samo kraj linije ili kraj bloka koda. Takvi komentari djeluju samo unutar PHP oznake i bit će čitati samo ako ih stavite u HTML.

// Ovo je standardni (C ++) način za stvaranje jednorednog komentara. Da biste stvorili jednorelni komentar. Možete koristiti i ovaj stil Unix ?>

2. Da biste napisali duge komentare ili testiranje, koristite višenamjenske komentare. Višeslojni komentari su vrlo korisni pri pisanju dugih objašnjenja i za sprečavanje obrade segmenta koda. Pročitajte odjeljak "Upotreba" da biste saznali o nekim savjetima o korištenju "višeslojnih komentara.

/ * Ovako vrijedi formalnontrofivni komentar. Čitav udžbenik na kraju etikete uključivat će komentar * // * neki vole uključiti * na vrh svakog retka * Dodatni markeri. Poboljšaće * Čitljivost velikih komentara, iako nije obavezna. * /?>

2. dio 2:

Upotreba

jedan. Koristite komentare za ostavljanje bilješki za efikasnost koda. Ne morate to raditi za svaki redak koda, jer se drugi programeri mogu lako shvatiti u dobro pisnom kodu. Komentari su korisni ako kôd obavlja nestandardne ili ne očite funkcije.

// Kreirajte zahtjev Curl $ sesion = Curl_init ($ Zahtjev) - // Recite Curl da biste koristili http postcurl_setopt ($ sesiju, curlopt_post, true)-

2. Ostavite komentare da ne zaboravite šta ste radili sa kodom. Kada radite na projektu, komentari neće dozvoliti da zaboravite ono što ste se zaustavili. Ostavite komentare za kod koji djeluje pogrešno ili još niste završili.

// Prije nego što nastavite na sljedeći korak, morate dvaput provjeriti rezultat ovog programa "Zdravo svijete!"-

3. Ostavite komentar za kôd koji planirate dijeliti. Ako planirate sarađivati s drugim programerima ili će vaš kod javno učiniti, komentari će pomoći drugima da shvate kako vaš kod djeluje i šta treba ispraviti.

/ * Postoji li efikasniji način za napraviti?* / Spol: ako (Pet ($ rod) && $ FOLD =="ženka") Eho "Provjereno"-?> Vrijednost ="ženka"> Ženski ako (Pet ($ rod) && $ FOLD =="Muško") Eho "Provjereno"-?> Vrijednost ="Muško"> Muško

4. Ostavite komentare za otkazivanje određenih blokova kodova. Sasvim je koristan kada testirate kod i želite zaustaviti rad neke vrste fragmenta. Prilikom pokretanja stranice, sve što je uključeno u oznaku komentara bit će zanemareni.

Eho "/ * Zdravo svijete!"-/ * Prilikom pokretanja spomenutog koda, riječ "zdravo" se ne odražava na * /?>

pet. Budite oprezni prilikom komentiranja velikih blokova koda. Funkcija komentiranja završit će se kada se prva marka završetka zaradi, pa ako je unutar koda koji ste već komentirali, je višeslojni komentar, ispada samo prije početnog komentara.

/ * Odjek "Zdravo svijete!"- / * Ovaj će komentar pokvariti * / * /?>

/ * Odjek "Zdravo svijete!"- // Ovim komentarom sve će biti u redu * /?>

6. Koristite komentare za stvaranje pseudo-snimača. Možete koristiti neke formate kreativnih kodova za kreiranje zapisa za kod direktno unutar njega. Sasvim je koristan za javno dostupne projekte.

// ============= // Naslov // ============= // ------------- // Titlle // ------------- / * Naziv odjeljka * / # Zapisi Možete pisati ovdje # Drugi dio možete pisati ovdje / * * Iskoristite ovo za objašnjenje: za koje vam treba nekoliko linija * ili čak nekoliko točaka objašnjenja * /?>

Savjeti

HTML i PHP komentari se međusobno razlikuju, pa kada radite sa scenarijima (kombinacija HTML-a i PHP-a) provjerite da koristite ispravnu sintaksu.
Na primjer, u sljedećem kodu nalazi se HTML komentar, ali i dalje obavlja PHP kod. Ako naručite komentar HTML unutar PHP oznake, to će rezultirati.