Kas yra HTML komentarai ir kaip jie naudojami
aJei peržiūrėjote tinklalapį naršyklėje, matote vaizdinį vaizdą apie tai, kokia programinės įrangos dalis (žiniatinklio naršyklė) rodoma pagal konkretaus tinklalapio kodą. Jei peržiūrėsite šio tinklalapio šaltinio kodą , pamatysite dokumentą, sudarytą iš įvairių HTML elementų, įskaitant pastraipas, antraštes, sąrašus, nuorodas, atvaizdus ir dar daugiau. Visi šie elementai pateikiami naršyklės lankytojo ekrane kaip dalis svetainės. Vienas dalykas, kurį galite rasti HTML kode, kuris nėra pateikiamas asmens ekrane, yra tai, kas vadinama "HTML komentarais".
Kas yra komentaras?
Komentaras - tai HTML, XML ar CSS kodo eilutė, kurios naršyklė ar analizatorius nežiūri ir neveikia. Tai paprasčiausiai įrašyta į kodą, kad būtų pateikta informacija apie kodą ar kitus kodų kūrėjų atsiliepimus.
Daugumoje programavimo kalbų yra pastabų, jas dažniausiai naudoja kodo kūrėjas vienai ar net daugiau nei vienos iš šių priežasčių:
- Apibūdinkite ir paaiškinkite sudėtingą kodą tiems, kam gali tekti ateityje dirbti, įskaitant patys save! Jie gali grįžti į 3 ar 6 kodą iš 12 ar daugiau mėnesių vėliau, o ne prisiminti, kodėl jie ką nors padarė tam tikru būdu. Komentarai gali padėti atsakyti į jų klausimus ir priminti jiems, kur jų protas buvo, kai jie pirmą kartą sukūrė tą puslapį.
- Pateikite išsamią informaciją apie tai, kada buvo redaguojamas ar peržiūrėtas kodas. Tai gali būti naudinga informacija ir veikti kaip vystymosi žurnalas, kai svetainė paskutinį kartą dirbo.
- Pašalinkite kodo dalis, bet palikite juos naudoti vėliau. Tai dažnai atliekama bandymų ir derinimo vietoje metu. Jei svetainėje kyla problemos ir nežinote, kas tai sukelia, galite komentuoti sekcijas vieną kartą karantine ir nustatyti problemą ir tada išspręsti bet kokias problemas.
- Kalbėkitės su kitais programuotojais, dirbančiais su kodu. Tai greičiausiai bus padaryta kūrimo metu kaip būdas dalintis informacija su kitais, dirbančiais su kodu tuo pačiu metu. Jei šios pastabos yra tik pokalbiai apie plėtrą, geriausia pašalinti juos iš kodo prieš pradedant svetainę.
Tradiciškai HTML komentarai naudojami beveik visiems elementams, nuo sudėtingų lentelių struktūrų paaiškinimų iki pačių puslapio turinio informatyvių pastabų. Kadangi komentarai nėra pateikiami naršyklėje, juos galite pridėti bet kur HTML ir nesijaudinkite, ką jis padarys, kai svetainę žiūri klientas.
Kaip rašyti komentarus
Rašyti komentarus HTML, XHTML ir XML yra labai lengva. Supaprastinkite norimą tekstą su šiais:
ir ->Kaip matote, šie komentarai prasideda simboliu "mažiau nei simbolis", taip pat ištraukos tašku ir dviem brūkšneliais. Komentaras baigiasi dar dviem brūkšneliais ir simboliu "didesnis nei: simbolis". Tarp šių simbolių galite rašyti viską, ko norite sudaryti komentaro kūną.
CSS yra šiek tiek kitoks, naudojant C kodo komentarus, o ne HTML. Pradedate su brūkšniu brūkšniu ir žvaigždute. Jūs baigiate komentarą su atvirkščia jo dalimi, žvaigždute, po kurios eina į priekį brūkšnys.
/ * komentuotas tekstas * /Komentarai yra mirusio meno
Dauguma programuotojų žino naudingų komentarų vertę. Komentuojamas kodas palengvina kodo perkėlimą iš vieno komandos nario į kitą. Komentarai padeda QA komandai išbandyti kodą, nes jie gali pasakyti, ko kūrėjas ketino - net jei jis nebuvo pasiektas. Deja, interneto svetainių kūrimo platformų, tokių kaip WordPress, populiarumas, kuris leidžia jums pakilti ir paleisti pasirinktą temą, kuri tvarko daug, bet dar neapsiriboja HTML jums, kaip dažnai komentarus dažniausiai naudoja žiniatinklio komandos. Taip yra todėl, kad daugelyje vizualiųjų kūrimo įrankių komentarų yra sunku suprasti, jei tiesiogiai nesinaudojate kodu. Pavyzdžiui, svetainės viršuje, o ne matydami:
Vaizdinis įrankis rodo mažą piktogramą, rodančią, kad yra komentaras. Jei dizaineris fiziškai atidaro komentarą, jis niekada negali matyti jo. O pirmiau pateikto puslapio atveju gali kilti problemų, jei ji redaguoja puslapį ir kad redagavimas yra perrašytas komentare paminėto scenarijaus.
Ką galima padaryti?
- Rašykite prasmingus ir naudingus komentarus. Nesitikėkite, kad kiti žmonės galėtų perskaityti jūsų komentarus, jei jie yra per ilgi arba neįtraukti naudingos informacijos.
- Kaip kūrėjas, visada turėtumėte peržiūrėti visas pastabas, kurias matote puslapyje.
- Naudokite kūrimo programų programas, kurios leidžia jums pridėti komentarus.
- Naudokite turinio valdymą, kad galėtumėte valdyti puslapių redagavimą.
Net jei jūs esate vienintelis asmuo, kuris redaguoja jūsų tinklalapius, komentarai gali būti naudingi. Jei vieną kartą per metus redaguosite sudėtingą puslapį, lengva pamiršti, kaip sukūrėte lentelę ar sukūrėte CSS. Su komentarais jums nereikia prisiminti, nes tai čia parašyta jums.
Originalus straipsnis Jennifer Krynin. Redagavo Jeremy Girard 5/5/17