Kako umetnuti CSS komentar

Uključivanje komentara u svoj CSS kôd korisno je i preporučljivo.

Svaka web stranica sastoji se od strukturnih elemenata (koje diktiraju HTML), kao i vizualnog stila ili "izgleda i dojma" tog mjesta. Cascading Style Sheets (Cascading Style Sheets - Cascading Style Sheets) (Cascading Style Sheets - Cascading Style Sheets - Cascading Style Sheets - Cascading Style Sheets - Cascading Style Sheets - Cascading Style Sheets - Cascading Style Sheets - Ovi se stilovi drže odvojenima od HTML strukture kako bi se olakšalo ažuriranje i pridržavanje Web standarda.

S obzirom na veličinu složenosti mnogih web stranica danas, listovi stila mogu brzo postati dosta dugi i vrlo težak za rad. To je osobito istinito kada započnete dodavati medijske upite za responzivne stilove web mjesta . Ti medijski upiti sami mogu dodati značajnu količinu novih stilova u CSS dokument i čineći ga još teže raditi. Ovo je mjesto gdje komentari CSS-a mogu postati neprocjenjiva pomoć na web stranici.

Dodavanje komentara CSS datotekama na webu odličan je način dodavanja strukture odjeljaka tog koda za čitaoca ljudskog čitača koji pregledava dokument. Također je izvrsna metoda za objašnjavanje onih stilova za web profesionalce koji možda moraju raditi na mjestu u budućnosti - uključujući i sebe!

Naposljetku, pametno dodani komentari CSS-a olakšat će obradu stila. To je doista važno za stilske listove koje će uređivati ​​timovi. Komentari se mogu upotrebljavati za komuniciranje važnih aspekata tablice stila različitim članovima tima koji možda već nisu upoznati s kodom. Ovi komentari također mogu biti korisni za ljude koji su radili na web mjestu prije nego što se vrate u kôd nakon što su neko vrijeme bili daleko od njega. Često sam morao urediti web stranicu koju sam sagradio mjesecima ili čak godinama i imam dobro oblikovane komentare u HTML i CSS je vrlo dobrodošla pomoć! Zapamtite, samo zato što ste izgradili web mjesto ne znači da ćete se sjetiti zašto ste učinili ono što ste radili kada se vratite na to mjesto u budućnosti! Komentari mogu učiniti vaše namjere jasnim i razjasniti bilo kakve nesporazume prije nego što se i dogode.

Jedna stvar za razumijevanje o komentarima CSS-a jest da se ne prikazuju kada se stranica prikaže u web preglednicima. Ti komentari su samo informativni, baš kao i komentari HTML-a (iako je sintaksa različita između njih). Ovi komentari CSS-a ne utječu na vizualni prikaz stranice na bilo koji način i jednostavno su prisutni u samom kodu.

Dodavanje komentara CSS-a

Dodavanje komentara CSS-a vrlo je jednostavno. Jednostavno rezervirate svoj komentar s točnim otvaranjem i zatvaranjem oznaka komentara:

Sve što se pojavi između ove dvije oznake bit će sadržaj komentara koji je vidljiv samo u kodu, a koji ne prikazuje preglednik.

Komentar CSS-a može biti jedan redak ili može sadržavati više redaka. Evo primjera jednog retka:

div # border_red {border: tanki čvrsti crveni; } / * crveni granični primjer * /

I višestruki primjer:

/ *************************** ********************** ****** Stil za kodni tekst **************************** ************ *************** /

Razbijanje sekcija

Jedan od načina na koje često koristim komentare CSS-a jest organizirati svoj list stila u manjim, lakšim besprijekornim komadima. Volim biti u stanju lako vidjeti ove odjeljke kada kasnije proučim datoteku. Da biste to učinili, često dodam komentare s mnogo crtica u njima tako da pružaju velike, očite pauze na stranici koje se lako mogu vidjeti dok se brzo kretanje kroz kôd. Evo primjera:

/ * ----------------------- Stilovi zaglavlja ----------------------- ------- *

Kada vidim jedan od ovih komentara u mojem kodu, znam da je to početak novog odjeljka tog dokumenta, što mi omogućuje lakše obradu i upotrebu koda.

& # 34; Komentiranje iz & # 34; Kodirati

Oznake komentara također mogu biti korisne u stvarnom postupku kodiranja i ispravljanja pogrešaka na stranici. Komentari se mogu koristiti za "komentiranje" ili "isključivanje" područja tog koda da biste vidjeli što se događa ako taj odjeljak nije dio stranice.

Pa kako to radi? Pa, jer komentar oznake govore pregledniku da zanemari sve između njih, možete ih koristiti da privremeno onemogućuju određene dijelove CSS koda. To može biti korisno prilikom otklanjanja pogrešaka ili pri prilagođavanju oblikovanja web stranice.

Da biste to učinili, jednostavno biste dodali oznaku komentara otvaranja na koju želite da kôd započne s onemogućavanjem, a zatim stavite tu završnu oznaku na mjesto na kojem želite da se dio s invaliditetom završi. Sve između tih oznaka neće utjecati na vizualni prikaz web mjesta, što vam omogućuje uklanjanje pogrešaka u CSS-u da biste vidjeli gdje se problem može dogoditi. Tada možete ući i popraviti samo taj problem te ukloniti komentare iz koda.

CSS komentiranje savjeta

Kao recap, evo nekoliko savjeta za zapamćivanje korištenja komentara u svojem CSS-u:

  1. Komentari mogu obuhvaćati više redaka.
  2. Komentari mogu sadržavati elemente CSS koje preglednik ne želi pružiti, ali ne želite potpuno izbrisati. Ovo je lijep način za uklanjanje pogrešaka stranica stilova web-lokacije - samo uklonite neiskorištene stilove (za razliku od ostavljanja komentiranih) ako odlučite da ih ne trebate na web stranici
  3. Upotrijebite komentare svaki put kad napišete komplicirano CSS da biste dodali pojašnjenje i informirali buduće razvojne programere, ili sebe u budućnosti, o važnim stvarima koje bi trebali znati. To će spasiti buduće vrijeme razvoja svih uključenih.
  4. Komentari mogu također sadržavati meta informacije poput:
    • Autor
    • datum stvoren
    • informacije o autorskim pravima

Izvođenje

Komentari zasigurno mogu biti korisni, ali budite svjesni da što više komentara dodate u stilski list, to će postati, što će utjecati na brzinu i izvedbu web mjesta. Ovo je pravi problem, ali ne biste trebali oklijevati dodati korisne i legitimne komentare zbog bojazni da će performansi patiti. Linije CSS-a ne dodaju značajnu veličinu dokumentu. Trebali biste dodati TONS redaka komentara kako biste značajno utjecali na veličinu CSS datoteke. Dodavanje nekoliko korisnih komentara u svoj CSS ne bi trebalo pružiti neto negativan utjecaj na brzinu stranice.

Na kraju ćete htjeti pronaći ravnotežu između korisnih komentara i previše komentara da biste dobili prednosti i u CSS dokumentima.

Izvorni članak Jennifer Krynin. Uredio Jeremy Girard na 7/5/17