Pravilno komentirana HTML oznaka važan je dio dobro izgrađene web stranice. Ti će komentari biti lako dodati, a svatko tko će morati raditi na tom kodu web-lokacije u budućnosti (uključujući vas ili članove bilo kojeg tima s kojima radite) zahvaljuje vam na tim komentarima.
Kako dodati HTML komentare
HTML se može pisati standardnim uređivačem teksta, kao što je Notepad ++ za Windows ili TextEdit za Ma. Možete upotrijebiti web-dizajnerski program poput Adobe Dreamweaver ili čak CMS platformu kao što je Wordpress ili ExpressionEngine. Bez obzira na alat koji upotrebljavate za HTML autora, ako radite izravno s kodom, dodajte ovako sljedeće komentare na HTML:
- Dodajte prvi dio oznake HTML komentara:
- Nakon tog otvorenog dijela komentara, napišite tekst koji biste se željeli pojaviti za ovaj komentar. To će vjerojatno biti uputa za vašeg ili drugog razvojnog programera u budućnosti. Na primjer, ako želite odrediti gdje određeni odjeljak na stranici počinje ili završava na označavanju, možete upotrijebiti komentar da biste to detaljno opisali.
- Nakon dovršetka teksta vašeg komentara, zatvorite oznaku komentara kao što je ovaj: ->
- Tako će ukupni komentar izgledati ovako:
Prikazivanje komentara
Svaki komentar koji dodate u HTML kôd prikazat će se u tom kodu kada netko pogleda izvor web stranice ili otvori HTML u uređivaču kako bi izvršio neke izmjene. Taj tekst komentara, međutim, neće se pojaviti u web pregledniku kada obično dolaze posjetitelji na web mjestu. Za razliku od ostalih elemenata HTML-a, uključujući odlomke, naslove ili popise koji zapravo utječu na stranicu unutar tih preglednika, komentari su zapravo "iza kulisa" dijelova stranice.
Komentari za svrhe testiranja
Budući da se komentari ne pojavljuju u web pregledniku, oni se mogu koristiti za "isključivanje" dijelova stranice tijekom testiranja ili razvoja stranice. Ako dodate zapisni dio komentara izravno prije dijela stranice / koda koji želite sakriti, a zatim dodate završni dio na kraju tog koda (komentari u HTML-u mogu sadržavati više redaka, tako da možete otvoriti komentirati recenziju linije 50 svog koda i zatvoriti ga na liniji 75 bez ikakvih problema), tada se u pregledniku više neće prikazivati HTML elementi koji spadaju u taj komentar. Oni će ostati u vašem kodu, ali neće utjecati na vizualni prikaz stranice. Ako trebate testirati stranicu da biste vidjeli je li određeni odjeljak uzrokuje probleme, itd., To je bolje da je komentiralo to područje. S komentarima, ako se dio koda u pitanju ne dokazuje kao problem, jednostavno uklonite komentare i taj će kôd ponovno biti prikazan. Samo budite sigurni da ti komentari koji se koriste za testiranje ne čine ga proizvodnim web stranicama.
Ako se područje stranice ne bi trebalo prikazati, želite ukloniti kôd, a ne samo komentirati, prije pokretanja te web lokacije.
Jedna velika upotreba komentara na HTML-u tijekom razvoja jest kada izrađujete responzivnu web-lokaciju . Budući da će različiti dijelovi tog web-mjesta promijeniti izgled na temelju različitih veličina zaslona , uključujući i neka područja koja se možda ne prikazuju uopće, pomoću komentara za uključivanje ili isključivanje odjeljaka stranice može biti brz i jednostavan trik koji će se koristiti tijekom izvođenja.
Što se tiče izvedbe
Vidio sam neke web-stručnjake koji sugeriraju da bi komentari trebali biti uklonjeni iz HTML i CSS datoteka kako bi oborili veličinu tih datoteka i stvorili brže učitavanje stranica. Iako se slažem da stranice trebaju biti optimizirane za izvedbu i trebale bi se brzo učitavati, još uvijek postoji mjesto za pametnu upotrebu komentara u kodu. Imajte na umu da ti komentari trebaju olakšati rad na web-lokaciji u budućnosti, tako da sve dok ne zakažete s komentarima dodanim svakoj liniji u kodu, malu količinu veličine datoteke koja je dodana na stranicu zbog komentari bi trebali biti više nego prihvatljivi.
Savjeti za upotrebu komentara
Nekoliko stvari koje treba imati na umu ili zapamtite kada koristite HTML komentare:
- Komentari mogu biti više redaka.
- Upotrijebite komentare kako biste dokumentirali razvoj svoje stranice.
- Komentari mogu biti; tako da sadržaj dokumenta, tablični redovi ili stupci, praćenje promjena ili što god želite.
- Komentari koji "isključuju" područja web lokacije ne smiju ga proizvoditi, osim ako je ta promjena privremena koja će se ukratko preokrenuti (primjerice, ako je potrebna poruka upozorenja uključena ili isključena).