Tinkamai pakomentuota HTML žymėjimas yra svarbi gerai sukonstruoto tinklalapio dalis. Šiuos komentarus lengva pridėti, ir visi, kurie ateityje turės dirbti su tos svetainės kodu (įskaitant save ar bet kurios komandos, su kuria dirbate, narius), padėkos už tuos komentarus.
Kaip pridėti HTML komentarus
HTML gali būti sukurtas naudojant įprastą teksto rengyklę, pvz., „Notepad ++“, skirtą „Windows“, arba „TextEdit“, skirtą „Mac“. Taip pat galite naudoti į svetainių dizainą orientuotą programą, pvz., „Adobe Dreamweaver“, ar net TVS platformą, pvz., „Wordpress“ ar „ExpressionEngine“. Nepriklausomai nuo įrankio, kurį naudojate kurdami HTML, jei dirbate tiesiogiai su kodu, pridėtumėte tokius HTML komentarus:
Pridėkite pirmąją HTML komentaro žymos dalį:
Po komentaro pradžios parašykite bet kokį tekstą, kurį norėtumėte rodyti šiam komentarui. Tikėtina, kad tai bus jūsų ar kito kūrėjo instrukcijos ateityje. Pvz., Jei norite nurodyti, kur tam tikra puslapio skiltis prasideda ar baigiasi žymėjimu, galite tai išsiaiškinti naudodami komentarą.
Kai jūsų komentaro tekstas bus baigtas, uždarykite komentaro žymą taip:
Taigi iš viso jūsų komentaras atrodys maždaug taip:
Iš tikrųjų taip paprasta.
Komentarų rodymas
Visi komentarai, kuriuos pridėsite prie savo HTML kodo, bus rodomi tame kode, kai kas nors peržiūri tinklalapio šaltinį arba atidaro HTML redagavimo priemonėje, kad galėtų atlikti kai kuriuos pakeitimus. Tačiau komentaro tekstas nebus rodomas interneto naršyklėje, kai į svetainę ateis įprasti lankytojai. Skirtingai nuo kitų HTML elementų, įskaitant pastraipas, antraštes ar sąrašus, kurie iš tikrųjų veikia puslapį tose naršyklėse, komentarai iš tikrųjų yra „už kadro“.
Pastabos bandymų tikslams
Kadangi komentarai nerodomi žiniatinklio naršyklėje, juos galima naudoti norint „išjungti“ puslapio dalis bandant ar kuriant puslapį. Jei pridėsite pradinę komentaro dalį tiesiai prieš savo puslapio / kodo dalį, kurią norite paslėpti, tada pridėsite uždaromoji dalis to kodo pabaigoje (HTML komentarai gali apimti kelias eilutes, todėl galite atidaryti komentarą sakykime savo kodo 50 eilutę ir uždarykite jį 75 eilutėje be jokių problemų), tada visi HTML elementai, patenkantys į šį komentarą, nebebus rodomi naršyklė. Jie liks jūsų kode, tačiau neturės įtakos vizualiam puslapio vaizdavimui. Jei norite išbandyti puslapį, kad sužinotumėte, ar tam tikra skiltis kelia problemų ir pan., Geriau komentuoti tą sritį, o ne ją ištrinti. Pateikdami komentarus, jei paaiškėja, kad atitinkama kodo skiltis nėra problema, galite lengvai pašalinti komentaro dalis ir tas kodas bus rodomas dar kartą. Tiesiog įsitikinkite, kad šie testavimui naudojami komentarai nepatenka į gamybos svetaines. Jei puslapio sritis neturėtų būti rodoma, prieš paleisdami tą svetainę norite pašalinti kodą, o ne tik jį komentuoti.
Vienas puikus HTML komentarų panaudojimas kuriant yra tai, kai kuriate reaguojančią svetainę. Nes skirtingos tos svetainės dalys pakeis savo išvaizdą skirtingi ekrano dydžiai, įskaitant kai kurias sritis, kurios gali būti visai nerodomos, komentarų naudojimas norint įjungti arba išjungti puslapio sekcijas gali būti greitas ir paprastas triukas, kurį galima naudoti kuriant.
Dėl našumo
Mačiau, kai kurie interneto specialistai siūlo komentarus pašalinti iš HTML ir CSS failų, kad būtų galima nuskusti sumažinti tų failų dydį ir sukurti greičiau įkeliamus puslapius. Nors sutinku, kad puslapiai turėtų būti optimizuotas našumui ir turėtų greitai įkelti, vis dar yra vieta protingam komentarų naudojimui kode. Atminkite, kad šie komentarai skirti tam, kad ateityje būtų lengviau dirbti svetainėje, kol nepersistengsite komentarų, pridėtų prie kiekvienos jūsų kodo eilutės, nedidelis failo dydis, pridėtas prie puslapio dėl komentarų, turėtų būti didesnis nei priimtina.
Patarimai, kaip naudoti komentarus
Keli dalykai, į kuriuos reikia atkreipti dėmesį arba kuriuos reikia atsiminti naudojant HTML komentarus:
- Komentarai gali būti kelios eilutės.
- Naudokite komentarus, kad dokumentuotumėte savo puslapio vystymąsi.
- Komentarai taip pat gali dokumentuoti turinį, lentelių eilutes ar stulpelius, stebėti pakeitimus ar ką tik norite.
- Komentarai, kurie „išjungia“ svetainės sritis, neturėtų jos gaminti, nebent šis pakeitimas yra a laikinas, kuris bus pakeistas per trumpą laiką (pavyzdžiui, įspėjimo pranešimas būtų įjungtas arba išjungtas kaip reikia).