Insluitende kommentaar in u CSS-kode is nuttig en word sterk aanbeveel.
Elke webwerf bestaan uit strukturele elemente (wat deur HTML gedikteer word) sowel as die visuele styl of "look and feel" van die webwerf. Cascading Style Sheets (CSS) is wat gebruik word om die visuele voorkoms van 'n webwerf te dikteer. Hierdie style word apart van die HTML-struktuur gehou sodat dit makliker kan word om die webstandaarde op te dateer en te gehoorsaam.
Met die grootte van die kompleksiteit van baie webwerwe vandag, kan style sheets vinnig baie lank en baie omslagtig wees om mee te werk. Dit is veral waar as jy begin met media-navrae vir reageer webwerf style . Daardie media-navrae alleen kan 'n aansienlike hoeveelheid nuwe style by 'n CSS-dokument voeg en dit selfs moeiliker maak om mee te werk. Dit is waar CSS-kommentaar 'n waardevolle hulp op 'n webwerf kan word.
Om kommentaar op 'n webwerf se CSS-lêers by te voeg, is 'n goeie manier om strukture by dele van daardie kode by te voeg vir 'n menslike leser wat die dokument hersien. Dit is ook 'n wonderlike metode om die style te verduidelik vir 'n webprofessor wat moontlik in die toekoms op die werf moet werk - insluitend jouself!
Op die ou end, slim bygevoeg CSS kommentaar sal maak 'n stylblad makliker om te verwerk. Dit is inderdaad belangrik vir stylvelle wat deur spanne geredigeer sal word. Kommentaar kan gebruik word om belangrike aspekte van die stylblad te kommunikeer aan verskillende lede van die span wat dalk nie reeds bekend is met die kode nie. Hierdie kommentaar kan ook baie nuttig wees vir mense wat reeds op die werf gewerk het, as hulle terugkom in die kode nadat hulle dit vir 'n geruime tyd weg is. Ek het gereeld 'n webwerf wat ek maande of selfs jare gelede gebou het, gewysig en met goed geformatteerde kommentaar in die HTML en CSS is baie welkom help! Onthou, net omdat jy 'n webwerf gebou het, beteken dit nie dat jy sal onthou hoekom jy die dinge gedoen het wat jy gedoen het toe jy terugkeer na daardie webwerf in die toekoms nie! Kommentaar kan jou bedoelings duidelik maak en enige misverstande duidelik maak voordat hulle selfs gebeur.
Een ding om te verstaan oor CSS-kommentaar is dat hulle nie vertoon word wanneer die bladsy in webblaaier plaasvind nie. Die kommentaar is slegs inligting, net soos HTML-kommentaar is (alhoewel die sintaks verskil tussen die twee). Hierdie CSS-kommentaar het geen invloed op die visuele vertoning van 'n webwerf op enige manier nie en is eenvoudig in die kode self.
Voeg CSS-opmerkings by
Om 'n CSS-kommentaar by te voeg is redelik maklik. Jy boek net jou kommentaar met die korrekte opening en sluiting kommentaar tags:
- Begin jou kommentaar deur die byvoeging van / *
- Maak jou kommentaar deur te voeg * /
Enigiets wat tussen hierdie twee etikette verskyn, is die inhoud van die kommentaar, net sigbaar in die kode en nie deur die blaaier gelewer nie.
'N CSS-kommentaar kan 'n enkele reël wees, of dit kan veelvuldige lyne opneem. Hier is 'n enkele voorbeeld:
div # border_red {grens: dun soliede rooi; } / * rooi grens voorbeeld * /En 'n multiline-voorbeeld:
/ ************************** ********************** ****** Styl vir kode teks *************************** ************ *************** /Uitbreek van afdelings
Een van die maniere waarop ek CSS-kommentaar gebruik, is om my stylblad te organiseer in kleiner, makliker ontoeganklike stukke. Ek kan hierdie gedeeltes maklik sien as ek die lêer later lees. Om dit te doen, voeg ek dikwels kommentaar met baie koppeltekens in hulle sodat hulle groot, duidelike breek op die bladsy gee wat maklik is om te sien as ek vinnig deur die kode blaai. Hier is 'n voorbeeld:
/ * ----------------------- Header Styles ----------------------- ------- * /As ek een van hierdie opmerkings in my kode sien, weet ek dit is die begin van 'n nuwe afdeling van die dokument, sodat ek die kode makliker kan verwerk en gebruik.
& # 34; Lewer kommentaar op & # 34; kode
Kommentaar etikette kan ook nuttig wees in die werklike proses van kodering en ontfouting van 'n bladsy. Opmerkings kan gebruik word om areas van daardie kode te "kommentaar" of "afskakel" om te sien wat gebeur as daardie gedeelte nie deel van die bladsy is nie.
So, hoe werk dit? Wel, omdat die kommentaar etikette die leser vertel om alles tussen hulle te ignoreer, kan jy hulle gebruik om sekere gedeeltes van CSS-kode tydelik uit te skakel. Dit kan handig wees wanneer ontfouting gedoen word, of wanneer die opstel van webbladsye aangepas word.
Om dit te doen, voeg jy eenvoudig die opening kommentaar tag toe waar jy wil hê dat die kode moet word afgeskakel en plaas dan die einde tag waar jy die gedeaktiveerde gedeelte wil beëindig. Alles tussen die etikette sal nie die visuele vertoning van 'n webwerf beïnvloed nie, sodat jy die CSS kan ontfout om te sien waar 'n probleem kan gebeur. U kan dan net die probleem oplos en die kommentaar van die kode verwyder.
CSS Kommentaar Wenke
As 'n opsomming, hier is 'n paar wenke om te onthou vir die gebruik van kommentaar in jou CSS:
- Opmerkings kan oor verskeie lyne strek.
- Opmerkings kan CSS elemente insluit wat jy nie deur 'n blaaier wil gee nie, maar wil nie heeltemal uitvee nie. Dit is 'n goeie manier om 'n webwerf se style sheets te ontfout. Maak seker dat u ongebruikte style verwyder (in teenstelling met om kommentaar te lewer) as u besluit dat u dit nie op die webwerf nodig het nie.
- Gebruik kommentaar wanneer jy ingewikkelde CSS skryf om verduideliking by te voeg en toekomstige ontwikkelaars, of jouself in die toekoms, in te lig oor belangrike dinge wat hulle moet weet. Dit sal toekomstige ontwikkelingstyd vir alle betrokkenes red.
- Opmerkings kan ook meta-inligting insluit soos:
- skrywer
- datum geskep
- kopiereg inligting
Optrede
Kommentaar kan beslis nuttig wees, maar wees bewus daarvan dat hoe meer kommentaar jy by 'n stylvel voeg, hoe heffiger dit sal word, wat die aflaaispoed en prestasie van 'n webwerf sal beïnvloed. Dit is 'n ware besorgdheid, maar jy moet nie huiwer om nuttige en regmatige opmerkings by te voeg vir die vrees dat prestasie sal ly nie. Lijnen van CSS voeg nie aansienlike grootte toe aan 'n dokument. Jy sal TONS lyne van kommentaar moet voeg om 'n beduidende impak op die grootte van die CSS-lêer te maak. As jy 'n handvol nuttige kommentaar by jou CSS voeg, moet jy nie 'n negatiewe impak op bladsyspoed gee nie.
Uiteindelik sal u die balans tussen nuttige kommentaar en te veel opmerkings wil vind om die voordele van beide in u CSS-dokumente te kry.
Oorspronklike artikel deur Jennifer Krynin. Geredigeer deur Jeremy Girard op 7/5/17