Ce sunt comentariile HTML și cum sunt folosite
aDupă ce vizualizați o pagină web într-un browser, vedeți o reprezentare vizuală a ceea ce acea bucată de software (browserul web) se afișează pe baza codului unei anumite pagini Web. Dacă vizualizați codul sursă al paginii web, veți vedea un document alcătuit din diverse elemente HTML, inclusiv paragrafe, titluri, liste, linkuri, imagini și multe altele. Toate aceste elemente sunt redate de browser în ecranul unui vizitator ca parte a afișării site-ului web. Un lucru pe care îl puteți găsi în codul HTML care nu este redat pe ecranul unei persoane este ceea ce se numește "comentarii HTML".
Ce este un comentariu?
Un comentariu este un șir de cod în HTML, XML sau CSS care nu este vizualizat sau acționat de către browser sau parser. Este pur și simplu înscris în cod pentru a furniza informații despre codul respectiv sau alte informații de la dezvoltatorii de coduri.
Majoritatea limbajelor de programare au comentarii, sunt utilizate în mod obișnuit de către dezvoltatorul codului pentru una sau chiar mai multe, din următoarele motive:
- Descrieți și explicați codul complicat pentru cineva care ar putea fi nevoit să lucreze în viitor - inclusiv pe ei înșiși! Ei se pot întoarce la codul 3 sau 6 de 12 luni sau mai târziu și nu-și mai amintesc de ce au făcut ceva într-un anumit mod. Comentariile pot ajuta să răspundă la întrebările lor și să le reamintească de unde au avut mintea lor când au dezvoltat pentru prima dată acea pagină.
- Furnizați detalii despre momentul editării sau revizuirii codului. Acestea pot fi informații utile și pot acționa într-o oarecare măsură ca un jurnal de dezvoltare al site-ului în care a fost ultima dată lucrat.
- Eliminați secțiunile din cod, dar le lăsați disponibile pentru o utilizare ulterioară. Acest lucru se face adesea în timpul testelor și depanării site-urilor. Dacă aveți o problemă la un site și nu sunteți sigur ce cauzează acest lucru, puteți să faceți comentarii pe secțiuni câte unul la quarentină și să identificați problema și apoi să lucrați la o remediere pentru problemele pe care le aveți.
- Chat cu alți dezvoltatori care lucrează la cod. Acest lucru se va întâmpla probabil în timpul dezvoltării ca modalitate de a împărtăși detalii cu alții care lucrează la cod în același timp. Dacă aceste comentarii sunt doar conversații în curs de dezvoltare, este o practică optimă să le eliminați din cod înainte de lansarea unui site.
În mod tradițional, comentariile din HTML sunt folosite pentru aproape orice elemente, de la explicații ale structurilor de tabele complexe la remarci informative despre conținutul paginii în sine. Deoarece comentariile nu sunt redate într-un browser, le puteți adăuga oriunde în HTML și nu vă faceți griji cu privire la ceea ce va face atunci când site-ul este vizualizat de un client.
Cum să scrieți comentarii
Scrierea comentariilor în HTML, XHTML și XML este foarte ușoară. Încadrați pur și simplu textul pe care doriți să-l comentați cu următoarele:
și ->După cum puteți vedea, aceste comentarii încep cu un "mai puțin decât simbolul", plus un punct de exclamare și două liniuțe. Comentariul se termină cu încă două liniuțe și un simbol "mai mare decât :. Între aceste personaje poți scrie orice vrei să completezi corpul comentariului.
În CSS, este puțin diferit, folosind mai degrabă codurile C decât HTML. Începeți cu un slash lateral urmat de un asterisc. Încheiați comentariul cu inversul, un asterisc urmat de un slash înainte.
/ * text comentat * /Comentariile sunt o Dying Art
Majoritatea programatorilor cunosc valoarea comentariilor utile . Codul comentat simplifică transferarea acestui cod de la un membru la altul. Comentariile vă ajută să obțineți de la echipa de testare a codului, deoarece aceștia pot spune ce intenționează dezvoltatorul - chiar dacă nu a fost realizat. Din păcate, cu popularitatea platformelor de creare a site-urilor web, cum ar fi Wordpress, care vă permit să obțineți și să rulați cu o temă aleasă, care se ocupă de mult, dacă nu toate, de HTML-ul pentru dvs., comentariile nu sunt utilizate atât de des de echipele web. Acest lucru se datorează faptului că comentariile sunt greu de văzut în majoritatea instrumentelor de creație vizuală dacă nu lucrați direct cu codul. De exemplu, în loc să vedeți, în partea de sus a unei pagini web:
Instrumentul vizual arată o pictogramă minusculă care indică faptul că există un comentariu. Dacă designerul nu deschide fizic comentariul, el nu poate să-l vadă niciodată. Și în cazul paginii de mai sus, ar putea cauza probleme dacă editează pagina și că editare este suprascrisă de scriptul menționat în comentariu.
Ce se poate face?
- Scrieți comentarii semnificative și utile. Nu așteptați ca alte persoane să vă citească comentariile dacă sunt prea lungi sau nu includ informații utile.
- În calitate de dezvoltator, trebuie să consultați întotdeauna toate comentariile pe care le vedeți pe o pagină.
- Utilizați instrumentele furnizate de programele de creație care vă permit să adăugați comentarii.
- Utilizați gestionarea conținutului pentru a controla modul în care sunt editate paginile.
Chiar dacă sunteți singura persoană care vă editează paginile web, comentariile pot fi utile. Dacă editați o pagină complicată o dată pe an, este ușor să uitați cum ați construit masa sau ați pus împreună CSS. Cu comentarii, nu trebuie să vă amintiți, așa cum este scris acolo pentru tine.
Articolul original de Jennifer Krynin. Editat de Jeremy Girard pe 5/5/17