Ce înseamnă să comentezi o linie în php. Cum să comentezi pentru un timp HTML, CSS sau PHP, cod JS. Sintaxă comentariu PHP: comentariu pe o singură linie

... astăzi, în acest articol scurt, dar util, ne vom da seama cum este comentat diferit codul de program. Nu voi spune multe, deoarece dacă sunteți interesat de acest lucru, atunci ați întâlnit deja întrebările acestei probleme și aveți o idee despre ea.

Ați ajuns la adresa... dar câteva cuvinte pentru claritate și avantajul cazului. Probabil ați văzut cum se face acest lucru 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 etapa inițială a 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ă așa că, de exemplu, trebuie să dezactivați ceva timp cod html, și apoi reluați din nou funcția - este ușor de implementat dacă ați făcut note pentru dvs. în „marje”, 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 în mod specific și, prin urmare, codul aplicației este diferit.

Comentând codul CSS

a: hover, a: focus (culoare: # D5071E; text-decor: Overline; / * SUBLINIERĂ * /)

Așa vă explicați singur. Sau puteți chiar să comentați acest script CSS complet astfel: doar wrap

/ * aici COD * /

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

Vă atrag atenția asupra faptului că - puteți comenta întregul ciclu al codului css în acest fel, dar !! atunci trebuie să eliminați comentariile repetate / * SUBLINEAȚI JOS * / 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 frumos afișat în documentul generat! asta dacă a fost folosit css (proprietățile au fost setate) direct în html

Și, după cum știți, dacă treceți de la codul sursă prin referire la documentul css al șablonului dvs. activ, toate comentariile pot fi observate și studiate)) dacă cineva are nevoie de el. Dar acest lucru este puțin probabil)

Adverbul englezesc (cuvinte) va fi lizibil. Simbolismul rusesc - nr.

Comentând codul HTML

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

Important: verificati intotdeauna codul prevazut in articole, cel putin vizual) altfel pot aparea erori.

Neatenția obișnuită în timpul formatării poate consuma mult 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 s-a spus în observația anterioară - la fel și comentariul... codul html este afișat în documentul generat!

Tine cont de asta.

Și iată un alt lucru:

pe lângă faptul că codul comentat este afișat în codul sursă al paginii (ceea ce înseamnă că este procesat într-un anumit sens, deși va fi invizibil și 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țieisi va face treaba de minune: adica informatia nu va fi vazuta in frontend, ci in sursa - va fi afisata 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 codul html „extra” necesar deschiderea... functie inline ... si inchidere?> ...

Într-un cuvânt, așa o 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 va fi curat în raport cu dezvoltarea funcțiilor!

cum să comentezi JavaScript

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

Pentru claritate, am luat acest exemplu de cod JavaScript pe net, corectând ușor punctuația. Nu contează... Principalul lucru este să înțelegeți principiul...

După cum ați înțeles, bara oblică „//” este dublă, acesta este SEMNUL comentariului... ONE LINE!

Restul codului JS este comentat ca php, mai multe despre asta mai jos:

Observație:

Comentând codul PHP

... și ... aici este același - slash-slash ... pe o linie.

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

... sau așa puteți comenta - o opțiune cu o singură linie, când folosim NU DOUA SLASHES, ci BECAR (hash) înainte de linia comentată:

... Desigur, trebuie să comentați cu atenție în bucla de cod!

... sau în același mod - similar cu exemplul de mai sus pentru CSS ... i.e. această opțiune / * cod * / de comentare va funcționa 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...

Puteți comenta și în bucle php ca acesta, dacă codul este amestecat... php și cumva html

Similar cu mai sus:

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

sau cam așa: o opțiune cu o singură linie...

Inteligență:

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

În general, asta este tot ceea ce 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 Mikhalika.ru© - Usor cu WordPress

În această lecție, voi vorbi despre cum se face comentarii în HTML, CSS, PHP... Comentariile sunt text care nu este vizibil pe pagina web. Sunt folosite pentru tot felul de explicații, mementouri, descrieri pentru webmasteri, ceea ce vă permite să structurați documentul. Comentariile sunt indispensabile atunci când depanați codul, vă permit să navigați rapid în marcajul unei pagini web și să găsiți blocul de care aveți nevoie. Adesea, comentariile sunt folosite pentru a depana codul HTML. De exemplu, puteți comenta temporar un anumit bloc de cod, astfel încât să nu ruleze și, dacă este necesar, să poată fi restabilit cu ușurință.

Comentarii HTML

În HTML, comentariile sunt formate folosind simboluri:... Astfel, orice text între aceste simboluri este un comentariu. Să luăm în considerare un exemplu:

Exemple de comentarii HTML

Comentarii în CSS

Comentariile CSS sunt create folosind simbolurile: / * și * /. Pentru a crea un comentariu, trebuie doar să plasați codul paginii web între aceste simboluri:

/ * Începutul unui bloc cu stiluri pentru Body * / body (fond: #efeed; font-family: Verdana, Helvetica, sans-serif; font-size: 12px; margin: 0px; padding: 0px;) / * Sfârșitul un bloc cu stiluri pentru Body * /

Comentarii PHP

Comentariile PHP pot fi pe o singură linie sau pe mai multe rânduri:

1) Comentariile pe o singură linie în PHP sunt create folosind simbolurile: //. Trebuie doar să puneți acest simbol în fața liniei și va fi comentat.Această opțiune este folosită în cazul în care comentariul constă dintr-o singură linie.

2) Pentru a implementa comentarii pe mai multe rânduri, se folosesc următoarele simboluri: / * și * /. Această opțiune este utilă dacă comentariul se întinde pe mai multe rânduri.

Astfel, am învățat să facem

Comentariile în PHP sunt similare cu comentariile folosite în HTML. În sintaxa PHP, comentariile încep întotdeauna cu o secvență specială de caractere și tot textul 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 vedea comentariile PHP este să deschideți fișierul pentru editare. Acest lucru face comentariile PHP utile numai 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 fel de comentarii, PHP are două. Primul tip pe care îl vom discuta este comentariul pe o linie. Adică un comentariu care îi spune interpretului să ignore tot ce se întâmplă pe această 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 ... Poți să „nu vezi comentariile mele PHP!”; // ecou „nimic”; // echo „Numele meu este Humperdinkle!”; # echo „Eu nu” nici nu fac nimic „;?>

Rezultat:

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

Rețineți că mai multe 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 confuz sau pentru a elimina temporar o linie de cod PHP (pentru depanare).

Sintaxa comentariului PHP: comentariu pe mai multe linii

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

Rezultat.

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 își 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

Comentariul codului este disponibil în majoritatea limbajelor de programare (posibil toate, dar cu diferite grade de disponibilitate). De obicei, clarificările verbale sunt folosite pentru a ajuta alți membri ai echipei să se dezvolte în continuare sau pur și simplu pentru a ne aminti că această zonă are nevoie de remedieri („FIX ME”).

Desigur, o explicație a ceea ce este scris este o binecuvântare. Dar, cu ajutorul comentariilor, puteți șterge și toate aspectele 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 vă ajută să utilizați codul ca pe o instrucțiune. Un astfel de comentariu nu este perceput ca fiind de prisos, deoarece fără el nu există nimic. Imaginați-vă că cineva a folosit un cadru de creație și nu vă spune cum să utilizați programul;

JavaScript. Pornire rapidă

explicând. 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 repara codul în viitor. De exemplu, mulți tineri profesioniști văd un domeniu de îmbunătățire peste tot. Ei cred că lucrurile erau mai rele înaintea lor, iar acum este momentul să remedieze fiecare caracteristică.

Uneori, un sentiment similar îi copleș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 evita adepții să caute cele mai bune, programatorul 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 angajatorul tău.

Dar comentarea documentară a codului poate deveni un balast pentru 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, IDE-urile principale au o funcție corespunzătoare. PhpStorm nu ar trebui să facă excepție, dar din păcate. Căutați funcția în documentele de actualizare.

Etichetați ca element funcțional

În timp ce comentariile sunt menite să fie o explicație și un ajutor pentru dezvoltarea echipei, aceste caracteristici nu sunt utilizate în mod obișnuit. 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 atașa etichete specializate. Acest lucru se poate face după cum urmează.

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

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

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

Avantajul acestui tip de comentarii este acoperirea simultană a mai multor limbi. PHP este rareori singur. În acest fel, nu trebuie să recurgeți 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 pentru noi. Dacă nu ați folosit aceste funcții înainte, vă sfătuim 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