25.04.2017

Salut!
Continuăm să învățăm elementele de bază ale PHP de la zero!
În această lecție îți voi spune ce este un comentariu în PHP și în practică vom încerca să scriem comentariul tău în cod. Dar asta nu este tot. De asemenea, vreau să vă spun cum să comentați codul și de ce ar trebui făcut.

În ce este un comentariuPHP
Comentează înPHP este un indiciu pentru dezvoltatori php pentru orientare rapidă în cod, precum și pentru editare.

Un comentariu în PHP nu este vizibil pentru utilizatorul care a deschis pagina web pentru vizualizare. Chiar dacă utilizatorul decide să se uite la codul sursă al paginii, comentariul tot nu va fi vizibil, deoarece toate php.

Comentariu cod PHP

Există 2 tipuri de comentarii pentru codul PHP:

→ cu o singură linie
→ multilinie

⇒ Comentariu pe o singură linie pentru PHP
Pentru un comentariu pe o singură linie, utilizați caracterele „//” sau „#”

După aceste caractere, tot ce este scris pe un rând va fi ignorat și tratat ca un comentariu.

Abonați-vă pentru actualizare"; # abonați-vă (acesta este un comentariu) ?>

Abonați-vă pentru actualizare

⇒ Comentariu pe mai multe linii pentru PHP
Un comentariu pe mai multe linii pentru PHP începe cu „/*” și se termină cu „*/”.
Orice lucru dintre aceste caractere va fi ignorat și tratat ca un comentariu.
Un comentariu pe mai multe rânduri este utilizat dacă există mai multe rânduri în intrare.

Pe ecran, veți vedea doar următorul text:

Salutare cititori ai blogului - site !!!

P.S.: Comentează întotdeauna codul tău. Daca crezi ca iti vei aminti tot ce ai facut in cod peste 1-2 ani, te inseli, sansa este foarte mica. Chiar dacă îți amintești, va trebui să petreci mult timp studiind - ce, unde și de ce...
Faceți viitorul plăcut pentru dvs. - comentați codul și apoi vă veți spune „MULȚUMESC!!!”.
Lasă un comentariu în cod, îți va lua 1 minut din timpul tău, dar îți va economisi o zi întreagă în viitor.

Comentați codul PHP

Să presupunem că ați scris un cod php, dar din anumite motive trebuie să eliminați 2 linii din cod.
Nu mă grăbesc să elimin ceva din cod, mai ales dacă este cod php, mai bine îl comentez. Și brusc va fi necesar să returnați codul. Este mai ușor să anulați comentariile decât să scrieți codul într-un mod nou.

Cum să comentezi codul înPHP
Un exemplu cu un comentariu pe o singură linie:

Abonați-vă pentru actualizare"; ?>

Un exemplu cu un comentariu pe mai multe rânduri.

De la autor: comentarea este una dintre acele caracteristici care este ușor de implementat. În același timp, aceste elemente de editare pot fi de mare beneficiu pentru dezvoltatorii care transmit codul din mână în mână. Astăzi veți învăța cum să comentați un bloc în PhpStorm. Vom lua în considerare și restul funcționalității mediului de dezvoltare pentru a comenta conținutul programului.

Comentarii: bune și rele

Capacitatea de a comenta codul este disponibilă în majoritatea limbajelor de programare (poate toate, dar cu diferite grade de disponibilitate). De obicei, clarificările verbale sunt folosite pentru a ajuta alți membri ai echipei cu dezvoltarea ulterioară sau pur și simplu pentru a-și aminti că această zonă are nevoie de remedieri („FIX ME”).

Desigur, o explicație a ceea ce a fost scris este o binecuvântare. Dar, cu ajutorul comentariilor, puteți șterge toate părțile bune ale codului. Pentru a preveni acest lucru, este necesar să se facă distincția între tipurile de comentarii:

documentarea. O asociere bună ar fi conceptul de documentare pentru diverse software. Astfel de comentarii ajută la utilizarea codului, ca o instrucțiune. Un astfel de comentariu nu este perceput ca fiind de prisos, deoarece fără el nu există nicio cale. Imaginați-vă că cineva a folosit cadrul de creație și nu vă spune cum să utilizați programul;

JavaScript. Pornire rapidă

explicativ. Un cod bun de obicei nu are nevoie de ele. Cu cât vezi mai multe rânduri de comentarii într-un program, cu atât este mai probabil ca programul să fie scris prost. Desigur, aceasta nu este o regulă absolută.

Comentariile explicative pot fi utile pentru cei care vor corecta codul în viitor. De exemplu, mulți tineri profesioniști văd loc de îmbunătățire peste tot. Ei cred că totul era mai rău înaintea lor, iar acum este timpul să remedieze fiecare caracteristică.

Uneori, un sentiment similar îi depășește pe profesioniști. De exemplu, atunci când totul pare surprinzător de strâmb - trebuie să existe o soluție mai bună. Pentru a împiedica urmăritorii să caute ceva mai bun, un programator poate lăsa o notă ca aceasta: #time_spent_here=24h

După asemenea cuvinte, puțini oameni vor să petreacă atât de mult timp. Astfel, avertizați că multe opțiuni diferite au fost deja rezolvate. În același timp, ar trebui să evitați astfel de atacuri: #i_hate_this, #try_to_do_better_ass%%le. În acest fel, arăți doar o atitudine neprofesională. Nu te compromite pe tine și pe angajator.

Dar documentarea comentariilor de cod poate deveni, de asemenea, balast pentru un programator. De regulă, acestea sunt secțiuni masive care distrag atenția direct de la programare. Dar pentru a afișa codul fără comentarii, există o funcție corespunzătoare în IDE-urile principale. Nu ar trebui să fie o excepție și PhpStorm, dar din păcate. Căutați funcția în documentele de actualizare.

Tag ca element de funcționalitate

Deși comentariul a fost menit ca o clarificare și un ajutor pentru dezvoltarea echipei, aceste caracteristici nu sunt folosite la fel de des. De regulă, etichetele sunt plasate acolo unde doresc să oprească executarea codului. Să presupunem că aveți PHP încorporat în HTML. Și nu vrei să-l ștergi, vrei doar să vezi cum arată pagina fără ea. Pentru a face acest lucru, trebuie să urmați următoarea sintaxă:

JavaScript

…

…< div > . . . < / div > < ? -- закомментированныйкоднаphp -- > < div > . . . < / div >

După cum puteți vedea, cu acțiuni simple, puteți opri execuția codului fără a efectua măcar operațiuni complexe. Dar, de fapt, aceasta nu este încă apogeul optimizării. Confort suplimentar pentru dezvoltator este oferit de phpStorm IDE în sine. Folosind evidențierea și comenzile rapide de la tastatură, puteți comenta segmentul de cod selectat fără a atribui etichete specializate. Se poate face așa.

Folosind o metodă convenabilă pentru dvs., selectați o bucată de text (mouse, comenzi rapide).

Apăsați comanda rapidă de la tastatură Ctr + Shift + /

În plus, puteți comenta linia curentă. Tot la fel, doar fără Shift.

Avantajul acestui tip de comentarii este acoperirea simultană a mai multor limbi. PHP este rar în sine. Astfel nu trebuie să apelezi la etichetarea fiecăruia. Mediul acceptă mai multe limbi web. Doar selectați un fragment și vindeți combinația - acesta este codul multilingv și comentat. În același mod, poate fi activat.

Asta e tot ce avem. Dacă nu ați folosit aceste funcții înainte, vă încurajăm să începeți. Abrevierile fac munca mai rapidă și mai bună.

JavaScript. Pornire rapidă

Aflați elementele de bază ale JavaScript cu un exemplu practic de construire a unei aplicații web

Comentariile în PHP sunt similare cu comentariile folosite în HTML. În sintaxa PHP, comentariile încep întotdeauna cu o secvență specială de caractere, iar orice text care apare între aceste caractere speciale va fi ignorat de interpret.

În HTML, scopul principal al unui comentariu este de a servi drept notă pentru dezvoltatori care pot vizualiza codul sursă al site-ului dvs. Comentariile PHP diferă prin faptul că nu vor fi afișate vizitatorilor. Singura modalitate de a vizualiza comentariile PHP este să deschideți fișierul pentru editare. Acest lucru face ca comentariile PHP să fie utile doar pentru programatorii PHP.

În cazul în care ați uitat sau nu știați cum se fac comentariile în HTML, vedeți exemplul de mai jos.

Sintaxă comentariu php: comentariu pe o singură linie

În timp ce html are un singur tip de comentariu, PHP are două tipuri. Primul tip pe care îl vom discuta este comentariul pe o singură linie. Adică un comentariu care îi spune interpretului să ignore orice se întâmplă pe acea linie din dreapta comentariilor. Pentru a utiliza acest comentariu, utilizați caracterele „//” sau „#” și tot textul din dreapta va fi ignorat de interpretul PHP.

Psst...Nu poți să-mi vezi comentariile PHP!"; // ecou „nimic”; // echo „Numele meu este Humperdinkle!”; # echo „Nici eu nu fac nimic”; ?>

Rezultat:

Salut Lume! Psst...Nu puteți vedea comentariile mele PHP!

Rețineți că câteva dintre comenzile noastre de eco nu au fost procesate deoarece le-am comentat cu caractere speciale de comentariu. Acest tip de comentariu este adesea folosit pentru a scrie rapid despre cod complex și ofuscat sau pentru a elimina temporar o linie de cod PHP (în scopuri de depanare).

Sintaxă comentariu php: comentariu cu mai multe linii

La fel ca comentariile HTML, comentariile pe mai multe linii în PHP pot fi folosite pentru a comenta blocuri mari de cod sau pentru a scrie comentarii pe mai multe rânduri. Comentariile pe mai multe linii în PHP încep cu „/*” și se termină cu „*/”. Orice lucru dintre aceste caractere va fi ignorat.

Rezultat.

... astăzi suntem în acest articol scurt, dar util, ne vom da seama cum se comentează diverse coduri de program. Nu voi vorbi prea mult, pentru că dacă sunteți interesat de acest lucru, atunci ați întâlnit deja întrebările acestei sarcini și aveți o idee despre asta.

Ai ajuns la locul potrivit... dar câteva cuvinte pentru claritate și utilitate. Trebuie să fi văzut cum se face cu codul CSS, deoarece css este de cel mai mare interes pentru mulți începători, ca mine.

… Bun!

Dar rețineți că comentariile sunt folosite și în html și php... Dar majoritatea începătorilor se confundă în stadiul inițial al muncii lor cu site-ul și nu știu cum să adauge explicațiile necesare pentru ei înșiși. La urma urmei, se întâmplă în același mod, de exemplu, trebuie să dezactivați ceva timp cod html, și apoi reluați din nou funcția - acest lucru este ușor de implementat dacă ați făcut note pe „margini”, dar nu știți niciodată ce.

Dar ce ar trebui reținut despre „comentarii” în general - totul aici depinde strict de fișierul cu care lucrați și, prin urmare, codul aplicației este diferit.

Comentând codul CSS

a:hover, a:focus (culoare: #D5071E; text-decor: Overline; /*subliniat în partea de sus*/ )

Așa vă explicați. Sau, în general, puteți comenta acest script CSS astfel: doar wrap

/* COD aici */

/*a:hover, a:focus (culoare: #D5071E; text-decor: subliniat; /*BOTTOM SUBLINE*/ )*/

Vă atrag atenția asupra faptului că - puteți comenta întregul ciclu de cod CSS în acest fel, dar !! atunci va trebui să eliminați comentariile repetate /* UNDERSHING BElow */, sau să vă jucați cu bare oblice dacă explicația este importantă))

Altfel va fi o eroare!!

Notă:

Dacă deschideți codul sursă al paginii - Ctrl + U și aruncați o privire... vom vedea că fragmentul de cod CSS comentat este perfect afișat în documentul generat! asta dacă a fost folosit css (proprietățile au fost setate) direct în html

Și, după cum înțelegeți, dacă urmați linkul de la codul sursă la documentul css al șablonului dvs. activ, puteți observa și studia toate comentariile)) dacă cineva are nevoie de el. Dar este puțin probabil.)

Dialectul englezesc (cuvinte) va fi lizibil. Simboluri rusești - nr.

Comentând codul HTML

Fișierul XML este comentat în același mod.

Important: verificati intotdeauna codul propus in articole, macar vizual, altfel pot aparea erori.

Simpla neglijență de formatare poate costa timp, de exemplu, codul COMENTAT de mai sus este adesea greșit: în loc de două cratime scurte, apare o liniuță em:

Pentru informația dumneavoastră:

așa cum sa menționat în observația anterioară - la fel și comentariul... codul html este afișat în documentul generat!

Tine cont de asta.

Și iată încă ceva:

pe lângă faptul că codul comentat este afișat în codul sursă al paginii (și, prin urmare, este procesat într-un anumit sens, deși va fi invizibil pe pagină!) - este mai bine să eliminați unele funcții php împreună cu html din documentul activ.

De exemplu:

va fi vizibil în document și în funcțieîși va face treaba remarcabil de bine: adică în front-end informația nu va fi vizibilă, dar în codul sursă va fi afișată clar! și aceasta este o cerere la baza de date: toate acestea sunt un fleac, dar trebuie să știți!

Este posibil să faceți acest lucru dacă nu doriți să scoateți o bucată de cod din document:

adăugați înainte de deschiderea codului html „extra” necesar… funcție în linie… și închidere?> …

Într-un cuvânt, iată ce puteți face dacă codul este mare:

**/ ?>

atunci sursa va fi curată!

Sau mai simplu:

Să comentăm funcția în sine în documentul html. Codul sursă în aceste cazuri privind dezvoltarea funcțiilor va fi curat!

cum să comentezi javascript

if (fiind afișat || afișat) ( // nu declanșează din nou animația return; ) else ( // aplică ORICE COMENTARIU pe linie // aplică ORICE COMENTARII pe linie // adevărat;

Acest exemplu de cod JavaScript - eu, pentru claritate, am prins pe net, corectând ușor punctuația. Nu contează... Principalul lucru este să înțelegi principiul...

După cum înțelegeți, bara oblică „//” este dublă, acesta este SEMNUL comentariului... SINGLE-LINE!

Și restul codului JS este comentat ca php, mai multe despre asta mai jos:

Notă:

Comentând codul PHP

... și ... aici este similar - slash-slash ... single-line.

Dar rețineți că poate fi comentat la fel ca codul CSS.

... sau puteți comenta astfel - o versiune pe o singură linie, când folosim NU TWO SASHES, ci BEKAR (hash) înainte de linia comentată:

…Desigur, comentarea ar trebui făcută cu atenție în bucla de cod!

... sau în acest fel - similar cu exemplul CSS prezentat mai sus ... adică. această opțiune de comentariu /* cod */ este potrivită atât pentru codurile CSS, cât și pentru codurile JS!

Dar în acest fel puteți comenta o explicație mai voluminoasă a codului PHP, undeva între exemplele sale principale...

De asemenea, puteți comenta în cicluri php dacă codul este amestecat... php și cumva html

Similar cu mai sus:

De exemplu, o astfel de funcție... undeva în codul general (sau o buclă în html):- puteți comenta, adică adăugați eticheta astfel:

sau așa: o singură linie...

Inteligență:

codul php nu este vizibil în niciun cod sursă!! doar rezultatul său funcțional este vizibil - funcționează!

Atât am vrut să raportez astăzi!

Acum poți experimenta... Mult succes.

Și, bineînțeles, citiți articolele site-ului și abonați-vă:
Îmi împărtășesc experiența mea amară - câteva cunoștințe, pentru bunăstarea ta dulce))

...orașul webmasterilor Michalika.ru© - ușor cu WordPress