Pravilno komentirana oznaka HTML je pomemben del dobro zgrajene spletne strani. Te pripombe je enostavno dodati in vsakdo, ki mora v prihodnosti delati na kodi tega spletnega mesta (vključno z vami ali člani katere koli ekipe, s katero delate), se vam bo zahvalil za te komentarje.
Kako dodati komentarje HTML
HTML je lahko avtor s standardnim urejevalnikom besedil, kot so Notepad ++ za Windows ali TextEdit za Ma. Prav tako lahko uporabljate program, osredotočen na spletno oblikovanje, kot je Adobe Dreamweaver ali celo platforma CMS, kot sta Wordpress ali ExpressionEngine. Ne glede na orodje, ki ga uporabljate za avtorja HTML, če delate neposredno s kodo, bi dodali komentarje HTML, kot je ta:
- Dodaj prvi del oznake oznake HTML:
- Po tem odprtju komentarja napišite katero koli besedilo, ki bi se želeli prikazati za ta komentar. To je verjetno, da bodo navodila za vašega ali drugega razvijalca v prihodnosti. Če na primer želite označiti, kje se določen razdelek na strani začne ali konča v oznaki, lahko s podrobnostmi uporabite komentar.
- Ko je besedilo vašega komentarja končano, zaprite oznako komentarja, kot je ta: ->
- Skupno bo vaš komentar izgledal takole:
Prikaz komentarjev
Vsi komentarji, ki jih dodate v svojo HTML kodo, bodo prikazani v tej kodi, ko nekdo pregleda vir spletne strani ali odpre HTML v urejevalniku, da naredi nekaj sprememb. Vendar besedilo tega komentarja ne bo prikazano v spletnem brskalniku, ko običajni obiskovalci pridejo na spletno mesto. Za razliko od drugih elementov HTML, vključno z odstavki, naslovi ali seznami, ki dejansko vplivajo na stran znotraj teh brskalnikov, so komentarji resnično »za nami« na straneh strani.
Pripombe za namene testiranja
Ker se komentarji ne prikazujejo v spletnem brskalniku, jih je mogoče uporabiti za "izklop" delov strani med testiranjem ali razvijanjem strani. Če prvem delu komentarja dodate neposredno pred delom vaše strani / kode, ki jo želite skriti, in nato na koncu kode dodate zaključni del (komentarji HTML lahko obsegajo več vrstic, tako da lahko odprete komentirajte vrstico 50 svoje kode in jo zaprite v vrstici 75 brez težav), nato pa ne boste več videli elementov HTML v tem komentarju v brskalniku. Oni bodo ostali v vaši kodi, vendar ne bodo vplivali na vizualni prikaz strani. Če želite preizkusiti stran, da vidite, ali določen odsek povzroča težave itd., Je bolje, če želite izbrisati to območje, izbrisati. S komentarji, če del zadevne kode ne bi bil problem, lahko preprosto odstranite komentarje in ta koda bo znova prikazana. Prepričajte se, da se ti komentarji, ki se uporabljajo za testiranje, ne uvrstijo v produkcijska spletna mesta.
Če se območje strani ne prikaže, želite odstraniti kodo, ne samo to, preden začnete to spletno mesto.
Ena velika uporaba komentarjev HTML med razvojem je, ko gradite odzivno spletno mesto . Ker bodo različni deli te strani spremenili svoj videz na podlagi različnih velikosti zaslona , vključno z nekaterimi področji, ki se morda sploh ne bodo prikazovali, je uporaba komentarjev za vklop ali izklop preostalih strani strani hiter in enostaven trik za uporabo med razvojem.
Glede uspešnosti
Videl sem, da nekateri spletni strokovnjaki nakazujejo, da je treba komentarje odstraniti iz datotek HTML in CSS, da bi zmanjšali velikost teh datotek in ustvarili hitrejše nalaganje strani. Čeprav se strinjam, da je treba strani optimizirati za učinkovitost in hitro naložiti, še vedno obstaja mesto za pametno uporabo komentarjev v kodi. Ne pozabite, da so ti komentarji namenjeni lažjemu delu na spletnem mestu v prihodnosti, tako dolgo, dokler ga ne zamudite s komentarji, dodanimi v vsako vrstico v svoji kode, je majhna količina velikosti datoteke dodana na stran, pripombe bi morale biti več kot sprejemljive.
Nasveti za uporabo komentarjev
Nekaj stvari, ki jih je treba upoštevati ali upoštevati pri uporabi komentarjev HTML:
- Komentarji so lahko več vrstic.
- Uporabite komentarje za dokumentiranje razvoja svoje strani.
- Komentarji lahko al; tako vsebino dokumenta, tabele vrstic ali stolpce, sledenje spremembam ali karkoli želite.
- Komentarji, ki jih je treba izklopiti, ne smejo vnesti v produkcijo, razen če je ta sprememba začasna, ki se bo obrnila v kratkem zaporedju (na primer, če je bilo vklopljeno ali izključeno opozorilno sporočilo).