Pravilno komentirano HTML oznake so pomemben del dobro zgrajene spletne strani. Te komentarje je enostavno dodati in vsi, ki boste morali v prihodnje delati s kodo tega spletnega mesta (vključno s seboj ali člani katere koli ekipe, s katero sodelujete), se vam bodo zahvalili za te komentarje.
Kako dodati komentarje HTML
HTML je mogoče ustvariti s standardnim urejevalnikom besedil, kot sta Notepad ++ za Windows ali TextEdit za Mac. Uporabite lahko tudi program, osredotočen na spletno oblikovanje, kot je Adobe Dreamweaver, ali celo platformo za upravljanje vsebin, kot sta Wordpress ali ExpressionEngine. Ne glede na orodje, ki ga uporabljate za ustvarjanje HTML-jev, če delate neposredno s kodo, dodate komentarje HTML, kot je ta:
Dodajte prvi del oznake komentarja HTML:
Po uvodnem delu komentarja napišite besedilo, ki bi ga želeli prikazati za ta komentar. To bodo v prihodnosti verjetno navodila za vašega ali drugega razvijalca. Če želite na primer določiti, kje se določen odsek na strani začne ali konča na oznaki, lahko s komentarjem to podrobno navedete.
Ko je besedilo komentarja končano, zaprite oznako komentarja takole:
Torej bo vaš komentar videti nekako takole:
Res je tako preprosto.
Prikaz komentarjev
Vsi komentarji, ki jih dodate kodi HTML, se v njej pojavijo, ko nekdo si ogleda vir spletne strani ali odpre HTML v urejevalniku, da izvede nekaj sprememb. Besedilo komentarja pa se ne bo pojavilo v spletnem brskalniku, ko na spletno mesto pridejo običajni obiskovalci. Za razliko od drugih elementov HTML, vključno z odstavki, naslovi ali seznami, ki dejansko vplivajo na stran v teh brskalnikih, so komentarji resnično "zakulisni" deli strani.
Pripombe za namene testiranja
Ker se komentarji ne prikažejo v spletnem brskalniku, jih je mogoče uporabiti za "izklop" delov strani med testiranjem ali razvojem strani. Če dodate uvodni del komentarja neposredno pred delom vaše strani / kode, ki ga želite skriti, nato pa dodate zaključni del na koncu te kode (komentarji HTML lahko obsegajo več vrstic, tako da lahko odprete komentar v recimo vrstici 50 vaše kode in brez težav ga zaprite v vrstico 75), kateri koli elementi HTML, ki spadajo v ta komentar, ne bodo več prikazani v brskalnik. Ostali bodo v vaši kodi, vendar ne bodo vplivali na vizualni prikaz strani. Če morate stran preizkusiti, da ugotovite, ali določen razdelek povzroča težave itd., Je komentiranje tega območja boljše kot brisanje. Če se izkaže, da zadevni odsek kode ni v težavi, lahko s komentarji enostavno odstranite komentarje in ta koda bo ponovno prikazana. Prepričajte se, da ti komentarji, ki se uporabljajo za testiranje, ne pridejo na delovna spletna mesta. Če območje strani ne bi smelo biti prikazano, morate kodo odstraniti, ne samo komentirati, preden zaženete to spletno mesto.
Odlična uporaba komentarjev HTML med razvojem je, ko gradite odzivno spletno mesto. Ker bodo različni deli tega spletnega mesta spremenili svoj videz glede na različne velikosti zaslona, vključno z nekaterimi področji, ki morda sploh ne bodo prikazana, je lahko uporaba komentarjev za vklop ali izklop odsekov strani hiter in enostaven trik za uporabo med razvojem.
Glede uspešnosti
Videl sem, da nekateri spletni strokovnjaki predlagajo odstranitev komentarjev iz datotek HTML in CSS, da se zmanjša njihova velikost in ustvarijo strani s hitrejšim nalaganjem. Čeprav se strinjam, da bi morale biti strani optimiziran za delovanje in bi se moral hitro naložiti, še vedno obstaja prostor za pametno uporabo komentarjev v kodi. Ne pozabite, ti komentarji naj bi olajšali delo na spletnem mestu v prihodnosti, če le ne boste pretiravali z komentarjev, dodanih v vsako vrstico vaše kode, naj bo majhna količina datoteke, dodana na stran zaradi komentarjev, večja od sprejemljivo.
Nasveti za uporabo komentarjev
Nekaj stvari, na katere morate biti pozorni ali si jih zapomniti pri uporabi komentarjev HTML:
- Komentarji so lahko v več vrsticah.
- S komentarji dokumentirajte razvoj vaše strani.
- Komentarji lahko dokumentirajo tudi vsebino, vrstice ali stolpce tabel, sledijo spremembam ali karkoli želite.
- Komentarji, ki "izklopijo" področja spletnega mesta, ne bi smeli začeti s proizvodnjo, razen če je ta sprememba a začasni, ki bo obrnjen v kratkem vrstnem redu (na primer vklop ali izklop opozorilnega sporočila kot potrebno).