Korralikult kommenteeritud HTML-i märgistus on hästi ehitatud veebilehe oluline osa. Neid kommentaare on lihtne lisada ja igaüks, kes peab selle saidi koodi tulevikus töötama (kaasa arvatud teie või teiega koostööd teinud meeskonna liikmed), tänan teid nende kommentaaride eest.
Kuidas lisada HTML-i kommentaare
HTML-i saab kirjutada tavalise tekstitöötlusprogrammiga, näiteks Notepad ++ jaoks Windows või TextEdit jaoks Ma. Võite kasutada ka veebidisaini keskendavat programmi nagu Adobe Dreamweaver või isegi CMS platvorm nagu Wordpress või ExpressionEngine. Sõltumata tööriistast, mida kasutate HTML-i autoriks, kui töötate otse koodiga, lisage HTML-i kommentaarid järgmiselt:
- Lisage HTML-i kommentaarimärgi esimene osa:
- Pärast selle kommenteerimise avamist kirjutage mis tahes tekst, mida soovite selle kommentaari jaoks kuvada. See on tõenäoliselt teie või mõne muu arendaja jaoks tulevikus juhis. Näiteks, kui soovite määrata, millises lehe teatud sektsioonis märgistus algab või lõpeb, võiksite seda kommenteerida kommenteerida.
- Kui teie kommentaari tekst on lõpule jõudnud, sulgege kommentaarikood nagu see: ->
- Nii et teie kommentaar näeb välja umbes selline:
Kommentaaride kuvamine
Kõik kommentaarid, mida lisate oma HTML-koodi, kuvatakse selles koodis, kui keegi vaatab veebisaidi allika või avab redaktoris HTML, et teha mõningaid muudatusi. See kommentaar tekst ei kuvata siiski veebibrauseris, kui tavalised külastajad saidile tulla. Erinevalt teistest HTML-elementidest, sealhulgas lõigetest, rubriikidest või loenditest, mis tegelikult lehte sellel brauseril mõjutavad, on kommentaarid lehe tükkideks.
Testimisotstarbelised märkused
Kuna kommentaare ei kuvata veebibrauseris, saab neid kasutada lehekülje osade "väljalülitamiseks" lehe katsetamise või arendamise ajal. Kui lisate kommentaari avamise osa otse lehe / koodi osana, mida soovite peita, siis lisate selle koodi lõpus sulgemisosa (HTML-kommentaarid võivad hõlmata mitu rida, nii et saate avada kommenteerida koodi rida 50 ja sulgeda see rida 75 ilma probleemideta), siis pole selle brauseris enam HTML-elemente, mis kuuluvad selle kommentaari alla. Need jäävad teie koodi, kuid see ei mõjuta lehe kuvamist. Kui teil on vaja testida lehte, et näha, kas teatud osa tekitab probleeme jne, on selle piirkonna kommenteerimine parem kui selle kustutamine. Kommentaaridega, kui vastava koodi sektsioon ei pruugi olla probleem, võite kommenteerimistükid lihtsalt eemaldada ja see kood kuvatakse veel kord. Lihtsalt veenduge, et need kommentaarid, mida kasutatakse testimiseks, ei vii selle tootmise veebisaitideni.
Kui lehe ala ei peaks kuvama, peate koodi eemaldama, mitte lihtsalt seda kommenteerima, enne selle saidi käivitamist.
Üheks suurepäraseks HTML-i kommentaarideks arenduse kasutamisel on see, kui loote reageerivat veebisaiti . Kuna selle saidi erinevad osad muudavad oma välimust erinevate ekraanisuuruste põhjal , sealhulgas mõned valdkonnad, mida võib üldse mitte kuvada, võib lehe sisse lülitamine või välja lülitamine kommentaaride abil olla kiire ja lihtne trikk, mida kasutada arendamise ajal.
Tulemuslikkuse osas
Olen näinud, et mõned veebi spetsialistid viitavad sellele, et HTML-i ja CSS-failide kohta tuleks kommenteerida, et nende failide suurust rühmitada ja kiirlaadimislehte luua. Kuigi olen nõus, et lehti tuleks jõudluse jaoks optimeerida ja see peaks kiiresti laadima, on ikkagi koht kommentaaride arukaks kasutamiseks koodis. Pidage meeles, et need kommentaarid on mõeldud selleks, et veebisait oleks tulevikus lihtsam töötada, nii et nii kaua, kui te ei kaota seda oma kommentaaridega, mis on lisatud teie koodi igasse reale, lisatakse väike faili suurus, mis on lehele lisatud kommentaarid peaksid olema rohkem kui vastuvõetavad.
Näpunäited kommentaaride kasutamiseks
Mõned asjad, mida tuleb HTML-i kommentaaride kasutamisel silmas pidada või meelde jätta:
- Kommentaarid võivad olla mitu rida.
- Kasutage kommentaare oma lehe arendamise dokumenteerimiseks.
- Kommentaarid saab al; nii dokumendi sisu, tabeli read või veergud, jälgige muudatusi või mida soovite.
- Kommentaarid, et saidi väljalülitamine ei tohiks tootmist toota, välja arvatud juhul, kui see muudatus on ajutine, mida muudetakse lühikeses järjekorras (nt kui hoiatussõnum on vajadusel sisse või välja lülitatud).