Komentarji v HTML so namenjeni pojasnilom in opombam v izvorni kodi. Brskalnik jih pri običajnem prikazu strani ne prikaže, zato so uporabni predvsem za razvijalca oziroma avtorja dokumenta. Z njimi si lahko pomagamo pri razlagi kode, označevanju odsekov dokumenta ali zapisovanju opomnikov za kasnejše dopolnitve.
Pomni: Komentarji so zapisani v izvorni kodi HTML, vendar se v običajnem prikazu spletne strani ne pokažejo kot del vsebine.
Osnovna pravila
- Komentar v HTML zapišemo med
<!--in-->. - Komentarji se v običajnem prikazu strani ne izpišejo.
- Komentarje uporabljamo za pojasnila, opombe in boljšo preglednost kode.
- Komentar je lahko enovrstičen ali večvrstičen.
- Znotraj komentarja ne smemo uporabiti zapisa
-->, ker ta označuje konec komentarja.
Primerjave
Enovrstični in večvrstični komentar
Komentar lahko zapišemo v eni vrstici ali pa ga razširimo čez več vrstic. Obe obliki sta veljavni, pomembno pa je, da ostane zapis jasen in pregleden.
| Vrsta komentarja | Primer |
|---|---|
| enovrstični komentar | <!-- To je komentar --> |
| večvrstični komentar | <!-- |
Pozor: Komentarji niso namenjeni prikazu vsebine obiskovalcu strani. Uporabljamo jih za pojasnila v kodi, ne pa kot nadomestilo za navadno besedilo dokumenta.
Uporaba komentarjev
V HTML komentarje vstavimo na naslednji način:
<!-- To je komentar -->
Komentarji se ne prikažejo v brskalniku, lahko pa so zelo koristni pri zapisovanju kode. Uporabimo jih lahko pri pojasnilih ali pa kot opomnik pri kasnejšem pregledu kode, kot na primer:
<!-- To je komentar -->
<p> To je odstavek besedila. </p>
<!-- Ne pozabi kasneje tu dodati besedila -->To je odstavek besedila.
Komentar lahko uporabimo tudi kot večvrstični komentar:
<!--
To je večvrstični komentar.
Uporabimo ga lahko za daljša pojasnila v kodi.
-->Pri pisanju komentarjev moramo paziti, da znotraj komentarja ne uporabimo zaporedja znakov -->, saj to označuje konec komentarja.
Pomni: Kratek in jasen komentar je navadno bolj uporaben kot predolg komentar, ki samo ponavlja tisto, kar je iz kode že razvidno.
Pogojni komentarji in sodobna praksa
Pogojni komentarji, ki so jih uporabljale stare različice brskalnika Internet Explorer, niso del sodobnega standarda HTML in jih danes ne uporabljamo več. Pri sodobni izdelavi strani dajemo prednost standardnim rešitvam in pregledni kodi.
Priporočila
- Komentarje uporabljaj za kratka in smiselna pojasnila v kodi.
- S komentarji označi pomembne dele dokumenta ali mesta za kasnejše dopolnitve.
- Komentarjev ne uporabljaj za besedilo, ki mora biti prikazano uporabniku.
- Komentarje piši pregledno in tako, da ne prekrivajo osnovne strukture kode.
- Pri sodobni kodi ne uporabljaj starih pogojnih komentarjev za Internet Explorer.