CSS-koodi kommentaaride lisamine on kasulik ja väga soovitatav.
Iga veebisait koosneb struktuurilistest elementidest (mida dikteerib HTML), samuti selle saidi visuaalset stiili või välimust. Kaskaadlaaditavate stiilide loend (CSS) on veebisaidi välimuse dikteerimine. Neid stiile hoitakse HTML-struktuurist eraldi, et võimaldada veebistandardite ajakohastamist ja adekvaatsust.
Tänapäeval on paljude veebisaitide keerukuse suurusega kiiresti stiililehed muutumas üsna pikaks ja väga tülikaks töötamiseks. See kehtib eriti siis, kui hakkate lisama meediumipäringuid tundlikule veebisaidi laadile . Üksnes need meediumipäringud võivad lisada CSS-dokumentidele märkimisväärse hulga uusi stiile ja muuta see veelgi raskemaks. Siin saab CSS-i kommentaarid veebisaidil saada hindamatuks abiks.
Veebilehe CSS-failide kohta kommentaaride lisamine on suurepärane võimalus selle koodi jaotiste struktuuri lisamiseks dokumendi läbivaatamisele lugejatele. See on ka suurepärane viis veebispetsialisti jaoks nende stiilide selgitamiseks, kellel võib olla tulevasel töökohal vaja - sh ennast!
Lõpuks muudab luhtunud CSS-i kommentaaride lisamine stiililehe lihtsamaks. See on tõepoolest oluline stiililehtede jaoks, mida meeskonnad redigeerivad. Kommentaarid saab kasutada stiililehe oluliste aspektide edastamiseks meeskonna erinevatele liikmetele, kes ei pruugi juba koodi tunda. Need kommentaarid võivad olla väga kasulikud ka inimestele, kes on saidil juba töötanud, kui nad hakkavad koodi tagasi minema mõnda aega eemal. Mul on tihti pidanud redigeerima veebisaiti, mille ma ehitasin juba mitu kuud või isegi aastaid ning HTML-i ja CSS-i jaoks on hästi vormistatud kommentaarid väga teretulnud! Pidage meeles, et just sellepärast, et olete saidi üles ehitanud, ei tähenda, et mäletate, miks sa tegid seda, mida tegite, kui tulete sellele saidile tagasi tulevikus! Kommentaarid võivad muuta oma kavatsused selgeks ja kõrvaldada kõik arusaamatused, enne kui need isegi juhtuvad.
Üks asi, mis CSS-i kommentaaridest aru saab, on see, et neid ei näidata, kui leht kuvab veebibrauserites. Need kommentaarid on ainult informatiivsed, nagu ka HTML-i kommentaarid (kuigi süntaks on nende kahe vahel erinev). Need CSS-i kommentaarid ei mõjuta mingil moel saidi visuaalset kuvamist ja on lihtsalt koodis endas olemas.
CSS-i kommentaaride lisamine
CSS-i kommentaaride lisamine on üsna lihtne. Sa lihtsalt broneeri oma kommentaar korrektsete avamis- ja sulgemiste kommentaaride siltidega:
- Alustage oma kommentaar, lisades / *
- Sulge oma kommentaar, lisades * /
Nende kahe märgi vahel ilmuvad kõik kommentaaride sisu, mis on nähtav ainult koodi ja mida brauser ei toeta.
CSS-i kommentaar võib olla üks rida või see võib hõlmata mitu rida. Siin on ühe rea näide:
div # border_red {piir: õhuke korralik punane; } / * punane piiripunkt * /Ja mitmejooneline näide:
/ *************************** ********************** ****** Kooditüübi stiil **************************** ************ *************** /Lõhkemisjaotised
Üks viis, kuidas ma sageli kasutavad CSS-i kommentaare, on minu stiililehe korraldamine väiksemates ja kergemini eemaldatavates tükkides. Mulle meeldib, et saaksin neid osi lihtsalt näha, kui vaatan faili hiljem. Selleks lisan tihti tihti kommenteerimisi, milles on palju sidekriipsusid, nii et need pakuvad lehel suuri, ilmselgelt pausid, mida on lihtne näha, kui ma kiiresti koodi liigutan. Siin on näide:
/ * ----------------------- Päise stiilid ---------------------- ------- * /Kui ma näen oma koodi ühte nendest kommentaaridest, tean, et see on selle dokumendi uue osa algus, mis võimaldab mul lihtsamalt koodi töödelda ja kasutada.
& # 34; kommenteerimine & # 34; Kood
Kommentaarmärgid võivad olla kasulikud ka lehe kodeerimisel ja silumisprotsessis. Kommentaare saab kasutada koodi kommenteerimiseks või välja lülitamiseks, et näha, mis juhtub, kui see osa ei ole lehe osa.
Kuidas see siis töötab? Noh, kuna kommentaaride sildid räägivad brauserist, et ignoreerivad kõike nende vahel, võite neid kasutada CSS-koodi teatud osade ajutiseks keelamiseks. See võib olla kasulik siis, kui see on silumiseks või veebilehe vormingu kohandamisel.
Selleks lisage lihtsalt avamise kommentaarimärk, kus soovite, et koodi hakatakse keelama, ja asetage see lõpp-märgend, kuhu soovite puudega osa lõpetada. Kõik need märgendid ei mõjuta saidi visuaalset kuvamist, võimaldades teil CSS-i silumiseks, et näha, kus probleem võib juhtuda. Seejärel võite sisestada ja parandada just selle probleemi ja eemaldada kommentaarid koodist.
CSS kommentaaride näpunäited
Järgnevalt on mõned näpunäited CSS-i kommentaaride kasutamise kohta.
- Kommentaarid võivad hõlmata mitu rida.
- Kommentaarid võivad sisaldada CSS-elemente, mida brauser ei soovi muuta, kuid ei soovi täielikult kustutada. See on tore viis veebilehe stiililehtede silumiseks - lihtsalt eemaldage kasutamata stiilid (erinevalt nende kommenteerimisest lahkumisest), kui otsustate, et te ei vaja neid veebisaidil
- Kasutage kommentaare, kui lisate selgitusi keerukate CSS-ide kirjutamiseks, ning teavitage tulevasi arendajaid või endist tulevikus olulisi asju, mida nad peaksid teadma. See säästab edaspidist arendusaega kõigi osalejate jaoks.
- Märkused võivad sisaldada ka metaandmeid nagu:
- autor
- loodud kuupäev
- autoriõiguse teave
Jõudlus
Kommentaarid võivad kindlasti olla abiks, kuid pidage meeles, et rohkem kommentaare, mida lisate stiililehele, muutub see heftieriks, mis mõjutab saidi allalaadimise kiirust ja jõudlust. See on tõeline mure, kuid te ei tohiks kõhkle lugeda kasulikke ja õigustatud kommentaare hirmu eest, et jõudlus kannatab. CSS-i read ei lisa dokumendile olulist suurust. Kommentaaride rida peaksite TONSile lisama, et avaldada olulist mõju CSS-faili suurusele. Kasutatavate kommentaaride lisamine teie CSS-i ei tohiks anda teile negatiivset mõju lehekülje kiirusele.
Lõpuks tahate leida tasakaalu kasulike kommentaaride ja liiga palju kommentaare vahel, et saada kasu nii oma CSS-dokumentidest.
Jennifer Krynini algne artikkel. Redigeeris Jeremy Girard 5.7.17