Korralikult kommenteeritud HTML märgistus on hästi ehitatud veebilehe oluline osa. Neid kommentaare on lihtne lisada ja kõik, kes peavad selle saidi koodiga tulevikus tegelema (sh teie ise või mis tahes meeskonna liikmed, kellega teete koostööd), tänavad teid nende kommentaaride eest.
Kuidas lisada HTML-i kommentaare
HTML-i saab kirjutada tavalise tekstiredaktoriga, näiteks Notepad ++ Windowsi jaoks või TextEdit Maci jaoks. Võite kasutada ka veebidisaini keskset programmi nagu Adobe Dreamweaver või isegi CMS-i platvormi nagu Wordpress või ExpressionEngine. Sõltumata HTML-i loomiseks kasutatavast tööriistast lisate HTML-i kommentaare järgmiselt, kui töötate otse koodiga:
Lisage HTML-i kommentaarimärgendi esimene osa:
Pärast seda kommentaari avaosa kirjutage mis tahes tekst, mida soovite selle kommentaari jaoks kuvada. Tõenäoliselt on see tulevikus teie või mõne muu arendaja juhised. Näiteks kui soovite määrata, kus lehe teatud jaotis algab või lõpeb märgistusega, võite selle täpsustamiseks kasutada kommentaari.
Kui teie kommentaari tekst on valmis, sulgege kommentaarimärk järgmiselt:
Nii et teie kommentaar näeb välja umbes selline:
See on tegelikult nii lihtne.
Kommentaaride kuvamine
Kõik kommentaarid, mille lisate oma HTML-koodile, ilmuvad selles koodis siis, kui keegi vaatab veebilehe allikat või avab redaktoris HTML-i muudatuste tegemiseks. Seda kommentaari teksti ei kuvata siiski veebibrauseris, kui tavalised külastajad saidile tulevad. Erinevalt teistest HTML-elementidest, sealhulgas lõikudest, pealkirjadest või loenditest, mis tegelikult mõjutavad lehte nende brauserite sees, on kommentaarid tõesti lehe lavatagused.
Märkused testimise eesmärgil
Kuna kommentaare ei kuvata veebibrauseris, saab neid lehe testimise või arendamise käigus lehe osade "välja lülitamiseks" kasutada. Kui lisate kommentaari avaosa otse selle lehe / koodi osa ette, mille soovite peita, ja lisate seejärel sulgemisosa selle koodi lõpus (HTML-i kommentaarid võivad hõlmata mitut rida, nii et saate avada kommentaari oma koodi ütlemisreale 50 ja sulgege see reale 75 probleemideta), siis kõiki selle kommentaari alla kuuluvaid HTML-elemente ei kuvata enam brauser. Need jäävad teie koodi juurde, kuid ei mõjuta lehe visuaalset kuvamist. Kui peate lehte testima, et näha, kas mõni jaotis põhjustab probleeme jne, on selle ala välja kommenteerimine eelistatav selle kustutamisele. Kui osutub, et kõnealune koodijagu pole probleem, saate kommentaaride abil hõlpsasti kommentaaripalad eemaldada ja seda koodi kuvatakse uuesti. Lihtsalt veenduge, et need testimiseks kasutatavad kommentaarid ei pääse tootmise veebisaitidele. Kui lehe ala ei tohiks kuvada, soovite enne selle saidi käivitamist koodi eemaldada, mitte lihtsalt kommenteerida.
HTML-i kommentaaride suureks kasutamiseks arenduse käigus on see, kui teete ehitust tundlik veebisait. Sest selle saidi erinevad osad muudavad oma välimust selle põhjal erinevad ekraanisuurused, sealhulgas mõned alad, mida ei pruugita üldse kuvada, võib kommentaaride kasutamine lehe jaotiste sisse- või väljalülitamiseks olla arendamise ajal kiire ja lihtne trikk.
Seoses jõudlusega
Olen näinud, et mõned veebiprofessionaalid soovitavad HTML- ja CSS-failidest kommentaarid eemaldada, et raseerida nende failide suurust ja luua kiiremini laaditavaid lehti. Kuigi olen nõus, et lehed peaksid olema optimeeritud jõudlusele ja peaks kiiresti laadima, on koodis kommentaaride nutikaks kasutamiseks siiski koht olemas. Pidage meeles, et need kommentaarid on mõeldud saidil töötamise lihtsustamiseks tulevikus, nii et kui te sellega üle ei pinguta Kommentaarid, mis on lisatud teie koodi igale reale, peaks kommentaaride tõttu lehele lisatud väike failisuurus olema suurem kui vastuvõetav.
Nõuanded kommentaaride kasutamiseks
HTML-i kommentaaride kasutamisel tasub meeles pidada või meeles pidada mõnda järgmist:
- Kommentaarid võivad olla mitmerealised.
- Kasutage oma lehe arengu dokumenteerimiseks kommentaare.
- Kommentaarid võivad dokumenteerida ka sisu, tabeliridu või veerge, jälgida muudatusi või mida iganes soovite.
- Kommentaarid, mis "lülitavad" saidi alad välja, ei tohiks seda tootmiseks muuta, kui see muudatus pole a ajutine, mis tühistatakse lühikese ajaga (näiteks kui hoiatusteade on sisse või välja lülitatud kui vaja).