Šta su HTML komentari i kako se koriste
a Kada pregledate web stranicu u pregledaču, videćete vizuelnu predstavu onoga što taj deo softvera (web pregledač) prikazuje na osnovu koda određene web stranice. Ako pogledate taj izvorni kod web stranice, videćete dokument sastavljen od različitih HTML elementa, uključujući stavke, naslove, liste, linkove, slike i još mnogo toga. Svi ovi elementi su prikazani od strane pretraživača na ekranu posjetioca kao dio prikaza web stranice. Jedna stvar koju možete naći u HTML kodu koji nije prikazan na ekranu osobe je ono što je poznato kao "HTML komentari".
Šta je komentar?
Komentar je niz koda unutar HTML-a, XML-a ili CSS-a koji pregledač ili parser ne gleda ili ne djeluje. Jednostavno je upisano u kod za pružanje informacija o tom kodu ili drugim povratnim informacijama od programera koda.
Većina programskih jezika ima komentare, obično ih koristi programer koda za jedan ili čak više od jednog od sledećeg razloga:
- Opišite i objasnite komplikovani kod nekome ko će možda morati da radi u budućnosti - uključujući i sebe! Mogu se vratiti na kod 3 ili 6 od 12 meseci ili više kasnije i ne sjećati se zašto su učinili nešto na određeni način. Komentari mogu pomoći da odgovore na njihova pitanja i podsećaju na to gde je njihov um bio kada su prvi put razvili tu stranicu.
- Navedite detalje o tome kada je kod uređen ili pregledan. Ovo može biti korisna informacija i djelovati donekle kao evidencija razvoja kada je lokacija poslednje radila.
- Uklonite delove koda, ali ostavite ih dostupnim za kasniju upotrebu. Ovo se često vrši tokom testiranja i debagovanja na lokaciji. Ako imate problem na sajtu i niste sigurni šta to uzrokuje, možete da komentarišete odeljke po jedan za vrijeme i da identifikujete problem, a zatim radite na popravku za sve probleme koje imate.
- Razgovarajte sa drugim programerima koji rade na kodu. To bi se verovatno učinilo tokom razvoja kao način da se istovremeno dijelimo detalji sa drugim osobama koje rade na kodu. Ako su ovi komentari čisto razvojni razgovori, najbolja je praksa da ih uklonite iz koda pre nego što se lokacija pokrene.
Tradicionalno, komentari u HTML-u se koriste za skoro sve elemente, od objašnjenja kompleksnih tablica struktura do informativnih napomena sadržaja same stranice. S obzirom da se komentari ne prikazuju u pretraživaču, možete ih dodati bilo gdje u HTML-u i nemaju brige o tome šta će učiniti kada se stranica pregleda od strane kupca.
Kako napisati komentare
Pisanje komentara u HTML, XHTML i XML je vrlo jednostavno. Jednostavno okružite tekst koji želite da komentarišete sa sledećim:
i ->Kao što vidite, ovi komentari počinju sa "manje od simbola", plus izuzetak i dva dirsa. Komentar se završava sa još dva dirsa i "većim od: simbola. Između tih likova možete napisati šta god želite da sastavite telo komentara.
U CSS-u, to je malo drugačije, koristeći komentare C koda, a ne HTML. Počet ćete sa kosom slijepom a zatim sa zvjezdicom. Završite komentar sa inverznom za to, asteriskom slijedi kretanje po dole.
/ * komentarisao tekst * /Komentari su umiruća umetnost
Većina programera zna vrednost korisnih komentara . Komentarisani kod olakšava premeštanje tog koda sa jednog člana tima u drugi. Komentari vam pomažu timu QA da testira kod, jer oni mogu reći šta je planer nameravao - čak i ako to nije postignuto. Nažalost, s popularnošću platformi za autorizaciju veba kao što je Wordpress, koji vam omogućavaju da ustanete i pokrenete odabranu temu koja obrađuje mnogo, ako ne i sve, HTML za vas, komentari se ne koriste često od strane web timova. To je zato što su komentari zaista teško videti u većini vizuelnih alata za autorizaciju ako ne radite direktno sa kodom. Na primjer, umjesto da vidite, na vrhu web stranice:
Vizuelni alat pokazuje malu ikonu koja označava da postoji komentar. Ako dizajner fizički ne otvori komentar, on to možda neće videti. U slučaju gore navedene stranice, može doći do problema ako izmeni stranicu i da je uređivanje prepisano scenarijom navedenom u komentaru.
Šta se može učiniti?
- Napišite značajne i korisne komentare. Nemojte očekivati da drugi ljudi čita vaše komentare ako su predugo ili ne uključuju korisne informacije.
- Kao programer, uvek treba da pregledate sve komentare koje vidite na stranici.
- Koristite alatke koje nude autorski programi koji vam omogućavaju da dodate komentare.
- Koristite upravljanje sadržajem kako biste kontrolisali kako se stranice uređuju.
Čak i ako ste jedina osoba koja uređuje vaše web stranice, komentari mogu biti korisni. Ako samo jednom uređujete komplikovanu stranicu jednom godišnje, lako je zaboraviti kako ste napravili sto ili spojili CSS. Sa komentarima, ne morate se zapamtiti, jer je to napisano tačno za vas.
Originalni članak Jennifer Krynin. Uredio Jeremy Girard 17.5.17