Ieskaitot komentārus savā CSS kodā ir noderīgi un ļoti ieteicami.
Katra vietne sastāv no strukturālajiem elementiem (kurus nosaka HTML), kā arī vizuālo stilu vai "izskatu" šajā vietnē. Kaskādes stila lapas (CSS) ir tas, ko izmanto, lai diktētu vietnes vizuālo izskatu. Šie stili tiek turēti atsevišķi no HTML struktūras, lai atvieglotu Web standartu atjaunināšanu un ievērošanu.
Mūsdienās daudzu tīmekļa vietņu sarežģītības pakāpes dēļ stila lapas var ātri kļūt diezgan garš un ļoti apgrūtinoši strādāt. Tas jo īpaši notiek, kad sākat pievienot multivides vaicājumus, lai pielāgotos vietnes stiliem . Vienīgi šie multivides vaicājumi CSS dokumentā var pievienot ievērojamu skaitu jaunu stilu un padarīt to vēl grūtāk strādāt. Šeit CSS komentāri var kļūt par nenovērtējamu palīdzību tīmekļa vietnē.
Vietnes CSS failu komentāru pievienošana ir lielisks veids, kā pievienot šo kodu sadaļai struktūru cilvēka lasītājam, kurš pārskata dokumentu. Tā ir arī brīnišķīga metode, kā izskaidrot šos stilus tīmekļa profesionāļiem, kuri nākotnē varētu strādāt šajā vietnē, ieskaitot sevi!
Galu galā gudri pievienoti CSS komentāri padarīs stilu lapu vieglāku apstrādi. Tas patiešām ir svarīgs stila lapām, kuras komandas rediģēs. Komentārus var izmantot, lai paziņotu svarīgus stila lapas aspektus dažādiem komandas dalībniekiem, kuri jau nav pazīstami ar kodu. Šie komentāri arī var būt ļoti noderīgi tiem cilvēkiem, kas jau ir strādājuši šajā vietnē, pirms viņi atkal nonāk kodā pēc kāda laika prombūtnes. Man bieži vajadzēja rediģēt vietni, kuru izveidoja mēnešus vai pat gadus atpakaļ, un HTML formātā komentējot, un CSS ir ļoti gaidīta palīdzība! Atcerieties, ka tikai tāpēc, ka esat izveidojis vietni, nenozīmē, ka jūs atceraties, kāpēc jūs to darījāt, kad atgriezīsit šajā vietnē nākotnē! Komentāri var padarīt jūsu nodomus skaidru un noskaidrot jebkādus pārpratumus, pirms tie pat notiek.
Viena lieta, lai saprastu par CSS komentāriem, ir tāda, ka tie neparādās, kad lapa parādās tīmekļa pārlūkprogrammās. Šie komentāri ir tikai informatīvi, tāpat kā HTML komentāri (kaut arī sintakse atšķiras starp abiem). Šie CSS komentāri nekādā veidā neietekmē vietnes vizuālo parādīšanu un ir vienkārši ietverti pašā kodā.
CSS komentāru pievienošana
CSS komentāra pievienošana ir diezgan vienkārša. Jūs vienkārši rezervējat savu komentāru ar pareizo atvēršanas un aizvēršanas komentāru tagus:
- Sāciet savu komentāru, pievienojot / *
- Aizveriet savu komentāru, pievienojot * /
Viss, kas parādās starp šiem diviem tagiem, būs komentāra saturs, tas ir redzams tikai kodā un netiek attēlots pārlūkprogrammā.
CSS komentārs var būt viena rinda vai arī tas var aizņemt vairākas rindas. Šeit ir viena rinda:
div # border_red (robeža: plāns, ciets sarkans; } / * sarkans pierobežas piemērs * /Un daudzrindu piemērs:
/ *************************** ********************** ****** Stils koda tekstam **************************** ************ *************** /Breaking Out Sections
Viens no veidiem, kā es bieži lietoju CSS komentārus, ir organizēt manu stila lapu mazākos, vieglāk noņemamos gabalos. Man patīk viegli redzēt šīs sadaļas, kad vēlāk aplūkoju failu. Lai to izdarītu, es bieži pievienoju komentārus ar daudzām defisēm, lai tie sniegtu lielas, acīmredzamas pārtraukumus lapā, kas ir viegli redzami, jo es ātri ritošu kodu. Šeit ir piemērs:
/ * ----------------------- Header stili ---------------------- ------- * /Kad manā kodā redzu vienu no šiem komentāriem, es zinu, ka tas ir šī dokumenta jauna sadaļas sākums, ļaujot mani vieglāk apstrādāt un izmantot kodu.
& # 34; Komentējot & # 34; Kods
Komentāru tagi var būt noderīgi faktiskajā lapas kodēšanas un atkļūdošanas procesā. Komentārus var izmantot, lai komentētu vai izslēgtu šī koda apgabalus, lai redzētu, kas notiek, ja šī sadaļa nav lapas daļa.
Tātad, kā tas darbojas? Nu, tāpēc, ka komentāru tagi liek pārlūkam ignorēt visu starp tiem, jūs varat tos izmantot, lai uz laiku atspējotu noteiktas CSS koda daļas. Tas var būt noderīgs, ja tiek veikta atkļūdošana vai pielāgojas Web lapas formatēšanai.
Lai to izdarītu, jūs vienkārši pievienotu atvēršanas komentāru tagu, kurā vēlaties, lai kods tiktu atspējots, un pēc tam ievietojiet šo beigu tagu, kurā vēlaties, lai atspējota daļa beigtos. Viss starp šiem tagiem neietekmēs vietnes vizuālo parādīšanu, ļaujot jums atkļūdot CSS, lai redzētu, kur var rasties problēma. Pēc tam varat atvērt šo problēmu un noņemt komentārus no koda.
CSS komentēšanas padomi
Kā kopsavilkumu, šeit ir daži padomi, kā atcerēties, kā komentēt komentārus savā CSS:
- Komentāri var ietvert vairākas rindas.
- Komentāri var ietvert CSS elementus, kurus jūs nevēlaties sniegt pārlūkprogrammā, bet nevēlaties pilnībā izdzēst. Tas ir jauks veids, kā atkļūdot vietnes stila lapas - vienkārši noņemiet neizmantotos stilus (pretēji, atstājot tos komentētus), ja izlemjat, ka tie nav vajadzīgi tīmekļa vietnē
- Izmantojiet komentārus ikreiz, kad rakstāt sarežģītu CSS, lai pievienotu skaidrojumus, un turpmāk informēt nākamos izstrādātājus vai sev par svarīgām lietām, kas viņiem būtu jāzina. Tas ietaupīs turpmāko izstrādes laiku visiem iesaistītajiem.
- Komentāri var ietvert arī meta informāciju, piemēram:
- autors
- izveidots datums
- informācija par autortiesībām
Veiktspēja
Komentāri, protams, var būt noderīgi, taču ņemiet vērā, ka vairāk komentāru jūs pievienojat stila lapai, jo tas kļūs lielāks, kas ietekmēs vietnes lejupielādes ātrumu un veiktspēju. Tas ir patiesi satraucošs, taču jums nevajadzētu vilcināties pievienot noderīgus un pamatotus komentārus, jo baidās, ka cīņa būs slikta. CSS līnijas dokumentam nepievieno ievērojamu izmēru. Jums būs jāpievieno komentāru rindu TONS, lai būtiski ietekmētu CSS faila lielumu. Pievienojot nedaudz noderīgu komentāru jūsu CSS, jums nevajadzētu neto negatīvi ietekmēt lapas ātrumu.
Galu galā jūs vēlaties atrast līdzsvaru starp noderīgiem komentāriem un pārāk daudziem komentāriem, lai gūtu priekšrocības gan jūsu CSS dokumentos.
Jennifera Krīnina oriģinālais raksts. Rediģējis Jeremijs Girards 17. un 17. jūlijā