Comentarii în cod HTML, CSS, JS și PHP. Cum se scrie comentarii html în cod? Cum se face o explicație în html

... astăzi, în acest articol scurt, dar util, vom afla cât de diferit este codul programului. Nu voi spune multe, pentru că dacă vă interesează acest lucru, atunci v-ați confruntat deja cu întrebările acestei probleme și aveți o idee despre ea.


Ai ajuns la adresa ... dar câteva cuvinte pentru claritate și beneficiul cazului. Probabil ați văzut cum se face acest lucru cu codul CSS, deoarece CSS este cel mai interesant pentru mulți începători, ca mine.

… Bun!

Rețineți însă că și comentariile sunt utilizate în html și php... Dar majoritatea începătorilor se confundă la 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 „margini”, dar nu știți niciodată ce.

Dar ce ar trebui amintit 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.

Comentează codul CSS

a: hover, a: focus (culoare: # D5071E; decorare text: Overline; / * UNDERLINE UP * /)

Așa te explici singur. Sau puteți chiar să comentați acest script CSS astfel: doar înfășurați

/ * COD aici * /

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

Vă atrag atenția asupra faptului că - puteți comenta ciclul complet al codului CSS în acest fel, dar !! atunci trebuie să eliminați comentariile repetate / * UNDERLINE BOTTOM * /, sau să vă jucați cu barele, 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ă bucata de cod css comentată este frumos afișată în documentul generat! asta dacă s-a folosit css (proprietățile au fost setate) direct în html

Și, după cum știți, dacă mergeț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 în engleză (cuvintele) va putea fi citit. Simbolismul rusesc - nu.

Comentează codul HTML

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

Important: verificați întotdeauna codul furnizat în articole, cel puțin vizual) altfel pot exista erori.

Neatenția obișnuită în formatare poate consuma mult timp, de exemplu, codul COMENTAT prezentat mai sus este adesea eronat: în loc de două cratime scurte, apare o liniuță em:

Pentru informația dumneavoastră:

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

Rețineți acest lucru.

Ș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 funcțieîși va rezolva lucrarea minunat: adică informațiile nu vor fi văzute în frontend, ci în sursă - vor fi afișate clar! și aceasta este o cerere bespontovy către 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 „suplimentar” necesar deschiderea... funcție inline ... și închidere?> ...

Într-un cuvânt, așa 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 ceea ce privește dezvoltarea funcțiilor!

cum să comentați JavaScript

if (beingShown || shown) (// nu declanșați din nou animația returnează;) else (// pe linie aplică ORICE COMENTAR // pe linie aplică ORICE COMENTAR // adevărat;

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

După cum ați înțeles, barba „//” este dublă, acesta este SEMNUL comentariului ... O LINIE!

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

Observație:

Comentând codul PHP

... și ... aici este la fel - slash-slash ... o linie.

Rețineți însă că poate fi adnotat la fel ca codul CSS.

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

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

... sau în același mod - similar cu exemplul de mai sus pentru CSS ... adică această opțiune / * cod * / comentariu 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ă codului PHP, undeva între principalele sale exemple ...

De asemenea, puteți comenta în bucle php de acest fel, dacă codul este mixt ... php și cumva html

Similar cu cele de mai sus:

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

cam asa ceva: o optiune cu o singura linie ...

Inteligență:

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

În general, asta am vrut să raportez astăzi!

Acum puteți experimenta ... Mult succes.

Și, desigur, citiți articolele site-ului și abonați-vă:
Îmi împărtășesc experiența amară - unele cunoștințe, pentru bunăstarea ta dulce))

... orașul webmasterilor Mikhalika.ru© - Cu ușurință cu WordPress

Michael 2016-05-05 1 HTML și CSS 2

Cum se scrie comentarii html în cod?

Astăzi vă voi spune cum să faceți comentarii în cod în html. Comentariile sunt un lucru foarte util. Ele nu afectează în niciun fel execuția codului și aspectul paginilor și nu pot fi văzute în codul sursă al paginii. De fapt, comentariile pot fi văzute numai prin deschiderea fișierului într-un editor. În Notepad ++, acestea sunt evidențiate în verde.

Cum se lasă comentarii în html?

Foarte usor. Sintaxa unui comentariu în limbajul de marcare este următoarea:

Astfel, puteți comenta nu numai o linie, ci mai multe. Principalul lucru de reținut este că- închidere. În interiorul unei astfel de construcții, puteți utiliza atât un text explicativ, cât și etichete între paranteze unghiulare, browserul nu le va citi.

După cum am spus, comentariul are următoarele caracteristici:

  1. nu este vizibil pe pagină
  2. și în codul sursă, de asemenea, nu, dar numai atunci când editați un fișier
  3. toate etichetele care sunt plasate în acesta nu vor fi procesate de browser în niciun fel

Pentru ce este

Scopul principal al comentariilor este de a ajuta alți dezvoltatori. În timpul aspectului, puteți indica în mod explicit ce parte a codului formează antetul și care parte formează partea principală. Desigur, programatorii experimentați l-ar fi dat seama fără el, dar citirea și înțelegerea codului se îmbunătățesc. Și, de asemenea, comentariile îi ajută pe oamenii care nu înțeleg bine html, până la urmă, măcar puțin să înțeleagă ce este scris. Iată un exemplu de utilizare a acestora:

A doua utilizare posibilă a unui comentariu este de a face o bucată de cod inactivă pentru o vreme, când nu doriți să o ștergeți, dar trebuie să faceți cumva executarea sa inactivă. Apropo, acest lucru poate ajuta la identificarea diferitelor erori de aspect.

În general, una dintre calitățile bune ale oricărui dezvoltator web este abilitatea de a scrie un cod frumos conceput și de înțeles. Acest lucru înseamnă că trebuie să utilizați indentare, să afișați cuibărirea elementelor, să lăsați, de asemenea, comentarii, dacă este necesar, să separați părțile principale ale documentului cu întreruperi de linie etc. Toate acestea îi ajută pe cei care vor edita codul în viitor, precum și pe autorul însuși, care nu se va pierde în propria creație.

Voi începe acest articol cu ​​ce sunt comentariile. Să presupunem că dezvolți un modul cu o structură complexă. Sau creați un aspect cu multe atașamente de elemente. În astfel de cazuri, cel mai bine este să marcați unele părți ale codului cumva - pentru aceasta, există comentarii.

Acum voi arăta în detaliu cele patru tipuri de comentarii, mai exact, toate tipurile lor pentru patru coduri diferite.

Comentarii HTML

Pentru a adăuga un comentariu la marcajul HTML, utilizați:

Tot ceea ce este în aceste etichete nu este vizibil pe ecran, dar este disponibil pentru vizualizare în codul sursă.

Comentarii în stiluri CSS

Pentru a adăuga un comentariu la stilurile CSS, utilizați:

Tot ceea ce este în aceste etichete nu este luat în considerare la formarea stilurilor, ci este disponibil pentru vizualizare în fișierul de stiluri în sine.

Comentarii JavaScript

Pentru a adăuga comentarii în JavaScript există cele două tipuri ale acestora.

Primul tip:

// Text, cod sau altele

Al doilea tip:

/ * Text, cod sau altul * /

Tot ce este în aceste etichete nu este luat în considerare la executarea scriptului, ci este disponibil pentru vizualizare în fișierul JavaScript în sine.

Comentarii în cod PHP

Acest limbaj de programare, spre deosebire de precedentele, are 3 tipuri de comentarii.

Primul tip:

// Text, cod sau altele

Al doilea tip:

/ * Text, cod sau altul * /

Și al treilea tip:

# Text, cod sau altele

Tot ceea ce este în aceste etichete nu este luat în considerare la executarea scriptului și este vizibil doar în fișierul PHP în sine.

Notă!

/ * / * Codul meu * / * /

vă va da o eroare.

În această lecție, voi vorbi despre cum comentarii în HTML, CSS, PHP... Comentariile sunt text care nu este vizibil pe pagina web. Acestea sunt utilizate pentru tot felul de explicații, mementouri, descrieri pentru webmasteri, ceea ce vă permite să structurați documentul. Comentariile sunt indispensabile la depanarea codului, vă permit să navigați rapid la marcarea 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 restaurat 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:

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 blocului cu stiluri pentru Body * / body (fundal: #efeded; font-family: Verdana, Helvetica, sans-serif; font-size: 12px; margin: 0px; padding: 0px;) / * End of block cu stiluri pentru Body * /

Comentarii PHP

Comentariile PHP pot fi cu o singură linie sau cu mai multe linii:

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

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

Astfel, am învățat să facem

În munca unui programator, trebuie să faceți în mod constant câteva note sub formă de comentarii, pentru a descrie o parte din cod sau mărci pentru viitor. Fiecare limbaj are propria sintaxă, motiv pentru care atunci când dezvoltăm pagini web, o problemă obișnuită este aceea de a nu ști cum să comentăm o linie în HTML sau doar un mic bloc simultan.

Comentarii HTML

Când dezvoltați o pagină web, este uneori necesar să ascundeți o parte a codului pentru o vreme sau să faceți o notă pentru programator. Pentru a nu utiliza aplicații suplimentare, de exemplu, transferul unei părți din cod într-un alt fișier, trebuie să știți cum să comentați o linie în HTML.

Spre deosebire de majoritatea limbajelor de programare, HTML nu are o funcție sau o etichetă specială pentru a crea un comentariu pe o singură linie. Dacă trebuie să „ascundeți” doar o singură linie sau o parte din aceasta, trebuie să utilizați setul de instrumente de limbaj clasic. Cu toate acestea, există mai multe modalități de a face acest lucru.

Comentariu standard

În HTML, cel mai simplu mod de a comenta o bucată de cod este de a folosi perechi de caractere speciale. Înainte de a începe un comentariu, trebuie să specificați „Astfel, tot ce se află în interiorul acestei structuri va fi ascuns utilizatorului atunci când pagina este încărcată.

Trebuie remarcat faptul că, atunci când lucrați cu un comentariu, trebuie să fiți extrem de atent. Atunci când îi definiți limitele, trebuie să verificați dacă a intrat vreo etichetă de deschidere sau de închidere, a cărei a doua parte a rămas în afara acesteia - în acest caz, încărcarea paginii va fi incorectă. De asemenea, nu puteți crea mai multe în interiorul unui singur comentariu - cu această scriere, primul semnal la sfârșitul părții de comentare va deschide întreaga parte ulterioară a textului ascuns.

Mai jos este un exemplu de ortografie corectă:

Acesta este un comentariu.

Etichetă

În HTML, puteți, de asemenea, să comentați liniile folosind o pereche specială de etichete - ... Este inclus în mod specific în sintaxa limbii în acest scop, dar majoritatea browserelor populare nu o acceptă, cu excepția Internet Explorer 8.0. Etichetă Util când anumite informații trebuie ascunse numai pentru IE 8.0, 4.0 și versiuni anterioare sau ca soluție temporară în timpul dezvoltării. Ceea ce este specific aici este că puteți comenta o parte a codului numai în corpul paginii, adică în interiorul etichetei .

În exemplul de mai jos, când pagina este încărcată în browserele specificate, va fi afișată o foaie albă, în alte programe, pagina va fi scrisă:

Acesta este un comentariu

.

Abordare neconvențională

În plus față de metodele clasice, puteți comenta codul în HTML folosind metode specifice. În plus față de structurile de limbaj HTML de bază, etichetele de script și etichetele de foaie de stil sunt adesea specificate în corpul paginii. Fiecare dintre ele are, de asemenea, propriile sale definiții de comentarii.

Astfel, dacă includeți partea necesară a codului într-una dintre etichetele specificate, atunci în interior puteți utiliza alte metode pentru a comenta o parte a codului pe pagina HTML. Astfel de metode nu sunt practic utilizate în practica modernă, totuși, pentru auto-dezvoltare sau, dacă este necesar, pentru a exclude posibila apariție a textului pe pagină, ele pot fi aplicate.

Când utilizați o etichetă de script sau o foaie de stil, comentariile pot fi cu o singură linie sau cu mai multe linii. Primele sunt definite prin construcția „//”, care, din momentul scrierii acestor caractere, comentează restul rândului. Pentru a ascunde o parte a codului, utilizați descrierea sintaxei „/ *” pentru a deschide și „* /” pentru a închide un comentariu. Dacă construcția de închidere nu este scrisă după simbolurile „/ *”, întregul cod HTML rămas va fi comentat.

Exemplul prezentat prezintă o modalitate de comentare non-standard:

/*

Это комментарий.

*/