Cum și de ce să adăugați comentarii la HTML

Comentat corect HTML marcajul este o parte importantă a unei pagini web bine construite. Aceste comentarii sunt ușor de adăugat și oricine va trebui să lucreze la codul site-ului respectiv în viitor (inclusiv dvs. sau membrii oricărei echipe cu care lucrați) vă va mulțumi pentru aceste comentarii.

Cum se adaugă comentarii HTML

HTML poate fi creat cu un editor de text standard, cum ar fi Notepad ++ pentru Windows sau TextEdit pentru un Mac. De asemenea, puteți utiliza un program centrat pe designul web, cum ar fi Adobe Dreamweaver sau chiar o platformă CMS precum Wordpress sau ExpressionEngine. Indiferent de instrumentul pe care îl utilizați pentru a crea HTML, dacă lucrați direct cu codul, ați adăuga comentarii HTML de acest fel:

  1. Adăugați prima parte a etichetei de comentariu HTML:

  2. După acea bucată de deschidere a comentariului, scrieți orice text doriți să apară pentru acest comentariu. Este posibil să fie instrucțiuni pentru viitorul dvs. sau pentru un alt dezvoltator. De exemplu, dacă doriți să desemnați unde începe sau se termină o anumită secțiune pe o pagină de marcare, puteți utiliza un comentariu pentru a detalia acest lucru.

    instagram viewer

  3. Odată ce textul comentariului dvs. este complet, închideți eticheta de comentariu astfel:

  4. Deci, în total, comentariul dvs. va arăta cam așa:

  5. Este chiar atât de simplu.

Afișarea comentariilor

Orice comentariu pe care îl adăugați la codul dvs. HTML va apărea în acel cod atunci când cineva vizualizează sursa paginii web sau deschide codul HTML într-un editor pentru a face unele modificări. Cu toate acestea, textul de comentariu nu va apărea în browserul web atunci când vizitatorii normali vin pe site. Spre deosebire de alte elemente HTML, inclusiv paragrafe, titluri sau liste, care au un impact efectiv asupra paginii din aceste browsere, comentariile sunt într-adevăr „în culise”.

Comentarii în scopuri de testare

Deoarece comentariile nu apar într-un browser web, ele pot fi folosite pentru a „dezactiva” părți ale unei pagini în timpul testării sau dezvoltării paginii. Dacă adăugați partea de deschidere a unui comentariu direct înainte de partea paginii / codului pe care doriți să o ascundeți, apoi adăugați partea de închidere la sfârșitul acelui cod (comentariile HTML pot cuprinde mai multe linii, astfel încât să puteți deschide un comentariu pe linia 50 a codului dvs. și închideți-l pe linia 75 fără probleme), atunci orice elemente HTML care se încadrează în acel comentariu nu vor mai fi afișate în browser. Acestea vor rămâne în codul dvs., dar nu vor afecta afișarea vizuală a paginii. Dacă trebuie să testați o pagină pentru a vedea dacă o anumită secțiune cauzează probleme etc., este de preferat să comentați acea zonă decât să o ștergeți. Cu comentarii, dacă secțiunea de cod în cauză se dovedește a nu fi problema, puteți elimina cu ușurință comentariile și codul respectiv va fi afișat din nou. Doar asigurați-vă că aceste comentarii care sunt utilizate pentru testare nu fac parte din site-urile de producție. Dacă nu trebuie afișată o zonă a unei pagini, doriți să eliminați codul, nu doar să îl comentați, înainte de a lansa acel site.

O utilizare excelentă a comentariilor HTML în timpul dezvoltării este atunci când creați un site web receptiv. Deoarece diferite părți ale acelui site își vor schimba aspectul în funcție de diferite dimensiuni de ecran, inclusiv unele zone care s-ar putea să nu fie afișate deloc, utilizarea comentariilor pentru a comuta sau dezactiva secțiunile unei pagini poate fi un truc rapid și ușor de utilizat în timpul dezvoltării.

În ceea ce privește performanța

Am văzut că unii profesioniști din domeniul web sugerează că comentariile ar trebui eliminate din fișierele HTML și CSS pentru a reduce dimensiunea acelor fișiere și a crea pagini cu încărcare mai rapidă. Deși sunt de acord că paginile ar trebui să fie optimizat pentru performanță și ar trebui să se încarce rapid, există încă un loc pentru utilizarea inteligentă a comentariilor în cod. Amintiți-vă, aceste comentarii sunt menite să ușureze lucrul pe un site în viitor, deci atâta timp cât nu exagerați cu comentarii adăugate la fiecare linie din codul dvs., cantitatea mică de dimensiune a fișierului adăugată la o pagină din cauza comentariilor ar trebui să fie mai mare de acceptabil.

Sfaturi pentru utilizarea comentariilor

Câteva lucruri de care să țineți cont sau să vă amintiți atunci când utilizați comentarii HTML:

  • Comentariile pot fi multiple.
  • Folosiți comentarii pentru a documenta dezvoltarea paginii dvs.
  • Comentariile pot documenta, de asemenea, conținutul, rândurile sau coloanele tabelului, pot urmări modificările sau orice ați dori.
  • Comentariile care „dezactivează” zonele unui site nu trebuie să fie transformate în producție decât dacă această modificare este o unul temporar care va fi inversat într-o ordine scurtă (cum ar fi activarea sau dezactivarea unui mesaj de alertă ca Necesar).