Kaj so komentarji HTML in kako se uporabljajo
a Ko si ogledate spletno stran v brskalniku, vidite vizualno predstavitev tega, kar ta programska oprema (spletni brskalnik) prikaže na podlagi kode določene spletne strani. Če si ogledate izvorno kodo spletne strani, boste videli dokument, sestavljen iz različnih elementov HTML, vključno z odstavki, naslovi, seznami, povezave, slike in drugo. Vse te elemente brskalnik prikazuje na zaslonu obiskovalca kot del prikaza spletne strani. Ena stvar, ki jo lahko najdete v kodi HTML, ki ni prikazana na zaslonu osebe, je tisto, kar je znano kot »komentarji HTML«.
Kaj je komentar?
Komentar je niz kode v HTML, XML ali CSS, ki ga brskalnik ali razčlenjevalnik ne gleda ali ne deluje. Preprosto je vpisana v kodo, da zagotovi informacije o tej kodi ali drugih povratnih informacijah razvijalcev kode.
Večina programskih jezikov ima pripombe, jih razvijalec kode pogosto uporablja za eno ali celo več kot eno od naslednjih razlogov:
- Opišite in razložite zapleteno kodo za nekoga, ki bo morda moral delati v prihodnje - tudi sami! Lahko se vrnejo na kodo 3 ali 6 od 12 mesecev ali več kasneje in ne spomnite, zakaj so naredili nekaj na določen način. Komentarji lahko pomagajo odgovoriti na njihova vprašanja in jih opomni, kje je bil njihov um, ko so prvič razvili to stran.
- Navedite podrobnosti o tem, kdaj je bila koda urejena ali pregledana. To so lahko koristne informacije in delujejo nekoliko kot razvojni dnevnik, ko je bilo spletno mesto nazadnje delano.
- Odstranite dele kode, vendar jih pustite na voljo za poznejšo uporabo. To se pogosto izvaja med testiranjem in odpravljanjem napak na spletnem mestu. Če imate težave na spletnem mestu in niste prepričani, kaj povzroča to, lahko na prvem mestu komentirate dele enega za quarentine in ugotovite težavo in nato odpravite težave, ki jih imate.
- Klepetajte z drugimi razvijalci, ki delajo na kodi. To bi najverjetneje potekalo med razvojem kot način deljenja podrobnosti z drugimi, ki hkrati delajo na kodi. Če so te pripombe izključno razvojni pogovori, je najboljša praksa, da jih odstranite iz kode, preden se spletno mesto začne.
Tradicionalno se komentarji v HTML uporabljajo za skoraj vse elemente, od pojasnil kompleksnih struktur tabele do informativnih opomb vsebine same strani. Ker v brskalniku ni komentarjev, jih lahko dodate kjerkoli v HTML-ju in ne skrbi, kaj bo storil, ko bo stranka pregledala stran.
Kako napisati komentarje
Pisanje komentarjev v HTML, XHTML in XML je zelo enostavno. Preprosto obkrožite besedilo, ki ga želite komentirati, z naslednjim:
in ->Kot lahko vidite, se te pripombe začnejo z "manj kot simbolom", plus izjavo in dve pomišljaji. Komentar se konča z dvema dodatnima besedama in s simbolom »večji od:«. Med temi znaki lahko napišete vse, kar želite, da sestavite telo komentarja.
V CSS-u je malo drugačen, če uporabljate komentarje kode C in ne HTML. Začnete se s poševnico, ki ji sledi zvezdica. S komentarjem končate z inverzno, zvezdico, ki ji sledi poševnica.
/ * komentirano besedilo * /Komentarji so Umirajoča umetnost
Večina programerjev pozna vrednost uporabnih komentarjev . Komentarirana koda olajša prenos te kode iz enega člana v drugo. Komentarji vam pomagajo ekipi QA, da preizkusijo kodo, saj lahko povedo, kaj namerava razvijalec - tudi če to ni bilo doseženo. Na žalost, s priljubljenostjo platform za avtoring spletnih strani, kot je Wordpress, ki vam omogočajo, da vstanete in delate z izbrano temo, ki z vami obravnava veliko, če ne vse, HTML za vas, komentarje spletnim skupinam ne uporabljajo tako pogosto. To je zato, ker je pri večini vizualnih avtorskih orodij komentarje res težko videti, če ne delate neposredno s kodo. Na primer, namesto da bi videli, na vrhu spletne strani:
Vizualno orodje prikazuje majhno ikono, ki označuje, da obstaja komentar. Če oblikovalec fizično ne odpre komentarja, ga morda nikoli ne bo videl. In v primeru zgornje strani lahko povzroči težave, če uredi stran in je urejanje prepisano s skriptom, navedenim v komentarju.
Kaj je mogoče storiti?
- Napišite smiselne in koristne komentarje. Ne pričakujte, da bodo drugi ljudje prebrali vaše komentarje, če so predolgi ali ne vsebujejo koristnih informacij.
- Kot razvijalec morate vedno pregledati vse komentarje, ki jih vidite na strani.
- Uporabite orodja, ki jih ponujajo programi za avtoring, ki vam omogočajo, da dodate komentarje.
- Uporabite upravljanje vsebine, da nadzirate urejanje strani.
Tudi če ste edina oseba, ki urejate vaše spletne strani, so komentarji lahko koristni. Če urejate le zapleteno stran enkrat letno, je preprosto pozabiti, kako ste zgradili mizo ali združili CSS. S komentarji se vam ni treba zapomniti, kot je napisano tam za vas.
Izvorni članek Jennifer Krynin. Uredil Jeremy Girard dne 5/5/17