Cum să adăugați comentarii în HTML

Marcajul HTML corect comentat este o parte importantă a unei pagini web bine construite. Aceste comentarii sunt ușor de adăugat, iar oricine va trebui să lucreze în viitor la codul site-ului (inclusiv pe dvs. sau pe membrii oricărei echipe cu care lucrați), vă mulțumesc 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 Ma. De asemenea, puteți utiliza un program web-centric, cum ar fi Adobe Dreamweaver sau chiar o platformă CMS cum ar fi Wordpress sau ExpressionEngine. Indiferent de instrumentul pe care îl utilizați pentru autorizarea codului HTML, dacă lucrați direct cu codul, ați adăuga comentarii HTML precum:

  1. Adăugați prima parte a etichetei comentariu HTML:
  2. După acea piesă de deschidere a comentariului, scrieți orice text doriți să apară pentru acest comentariu. Este posibil ca în viitor să fie instrucțiuni pentru dezvoltatorul dvs. sau pentru altul. De exemplu, dacă doriți să desemnați unde începe sau se termină o anumită secțiune dintr-o pagină în marcaj, puteți utiliza un comentariu pentru a detalia acest lucru.
  3. Odată ce textul comentariului dvs. este finalizat, închideți eticheta comentariului astfel: ->
  4. Deci, în total, comentariul dvs. va arăta astfel:

Afișarea comentariilor

Orice comentarii pe care le adăugați la codul HTML va apărea în acel cod atunci când cineva văd sursa paginii web sau deschide codul HTML într-un editor pentru a face unele modificări. Acest text de comentariu nu va apărea, totuși, în browserul web atunci când un vizitator normal ajunge pe site. Spre deosebire de alte elemente HTML, inclusiv paragrafe, titluri sau liste, care de fapt influențează pagina din interiorul acelor browsere, comentariile sunt într-adevăr "în spatele scenei" bucăți ale paginii.

Comentarii pentru scopuri de testare

Deoarece comentariile nu apar într-un browser web, ele pot fi folosite pentru a "dezactiva" părțile unei pagini în timpul testelor sau dezvoltării paginilor. Dacă adăugați partea de deschidere a unui comentariu direct în fața părții paginii / codului pe care doriți să o ascundeți, atunci adăugați partea de închidere la sfârșitul acelui cod (comentariile HTML pot include mai multe linii, astfel încât să puteți deschide o comentați pe linia 50 a codului dvs. și închideți-l pe linia 75 fără probleme), atunci toate elementele HTML care intră în acest 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., comentează această zonă este preferabilă să o ștergeți. Cu comentarii, în cazul în care secțiunea de cod în cauză se dovedește a nu fi problema, puteți elimina cu ușurință piese de comentariu și acest cod va fi afișat încă o dată. Doar asigurați-vă că aceste comentarii care sunt utilizate pentru testare nu o fac în site-urile de producție.

Dacă nu ar trebui 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 mare utilizare a comentariilor HTML în timpul dezvoltării este când construiți un site web receptiv . Deoarece diferite părți ale site-ului își vor schimba aspectul în funcție de diferite dimensiuni ale ecranului , inclusiv unele zone care nu pot fi afișate deloc, utilizarea comentariilor pentru a comuta sau dezactiva secțiunile unei pagini poate fi un truc rapid și ușor de folosit în timpul dezvoltării.

În ceea ce privește performanța

Am văzut unii profesioniști web care sugerează că comentariile ar trebui să fie dezbrăcate din fișierele HTML și CSS pentru a se răsturna dimensiunea acestor fișiere și a crea pagini cu încărcare mai rapidă. Deși sunt de acord că paginile ar trebui să fie optimizate pentru performanță și ar trebui să se încarce rapid, există încă un loc pentru utilizarea inteligentă a comentariilor în cod. Rețineți că aceste comentarii sunt menite să ușureze lucrul pe un site în viitor, atâta timp cât nu îl depășiți cu comentariile adăugate la fiecare rând din cod, dimensiunea mică a dimensiunii fișierului adăugată la o pagină din cauza comentariile ar trebui să fie mai mult decât acceptabile.

Sfaturi pentru utilizarea comentariilor

Câteva lucruri pe care trebuie să le țineți minte sau să le rețineți când utilizați comentarii HTML:

  1. Comentariile pot fi mai multe linii.
  2. Utilizați comentariile pentru a documenta dezvoltarea paginii dvs.
  3. Comentariile pot al; astfel încât conținutul documentului, rândurile sau coloanele de tabelă, modificările de urmărire sau orice doriți.
  4. Comentariile că zonele de "dezactivare" ale unui site nu ar trebui să facă acest lucru, cu excepția cazului în care această modificare este una temporară care va fi inversată în ordine scurtă (de exemplu, dacă aveți un mesaj de avertizare activat sau dezactivat după cum este necesar).