Як ўставіць CSS каментар

У тым ліку каментары ў кодзе CSS карысна і вельмі рэкамендуецца.

Кожны вэб-сайт складаецца з структурных элементаў (якія дыктуюцца HTML), а таксама візуальны стыль або «выглядаць і адчуваць сябе" гэтага сайта. Каскадныя табліцы стыляў (CSS) гэта тое, што выкарыстоўваецца, каб дыктаваць знешні выгляд вэб-сайта. Гэтыя стылі захоўваюцца асобна ад HTML структуры, каб забяспечыць лёгкасць абнаўлення і захаванне вэб-стандартаў.

З памерам складанасці многіх сайтаў сёння, табліцы стыляў могуць хутка стаць даволі працяглымі і вельмі грувасткімі для працы. Гэта асабліва дакладна , калі вы пачынаеце дадаваць у медыя - запытаў для адчувальных тыпаў вэб - сайтаў . Гэтыя адны запыты СМІ могуць дадаць значную колькасць новых стыляў у CSS дакумент і робяць яго яшчэ цяжэй працаваць. Тут каментары CSS могуць стаць неацэннай дапамогай на сайце.

Даданне каментароў да CSS-файлаў вэб-сайта з'яўляецца выдатным спосабам, каб дадаць структуру раздзелаў гэтага кода для чалавечага чытача, які разглядае дакумент. Гэта таксама выдатны спосаб для тлумачэння гэтых стыляў для вэб-прафесіянала, які, магчыма, прыйдзецца працаваць на месцы ў будучыні - у тым ліку сябе!

У рэшце рэшт, бойка дададзеныя каментары CSS зробяць стылі лягчэй апрацоўваць. Гэта, сапраўды, важна для табліц стыляў, якія будуць рэдагавацца камандамі. Каментары могуць быць выкарыстаны для сувязі важных аспектаў табліцы стыляў для розных членаў каманды, якія могуць быць не знаёмыя з ужо кодам. Гэтыя каментары могуць быць вельмі карысныя для людзей, якія працавалі на месцы раней, калі яны вернуцца ў код пасля таго, як ад яго на працягу некаторага часу. Мне часта даводзілася рэдагаваць вэб-сайт, я пабудаваў некалькі месяцаў ці нават гадоў таму і, добра адфарматаваны каментары ў HTML і CSS вельмі вітаецца дапамогу! Памятаеце, што толькі таму, што вы пабудавалі сайт не азначае, што вы будзеце памятаць, чаму вы зрабілі тое, што вы зрабілі, калі вы вернецеся на гэты сайт у будучыні! Каментары могуць зрабіць вашыя намеры ясна і ліквідаваць любыя непаразуменні, перш чым яны нават здарыцца.

Адна рэч, каб зразумець аб каментарах CSS з'яўляецца тое, што яны не адлюстроўваюцца, калі старонка адлюстроўваецца ў вэб-браўзэрах. Гэтыя каментары з'яўляюцца выключна для азнаямлення, гэтак жа, як каментары HTML з'яўляюцца (хоць сінтаксіс адрозніваецца паміж імі). Гэтыя CSS каментары не ўплываюць на візуальнае адлюстраванне сайта ў любым выпадку, і проста прысутнічаюць у самым кодзе.

Даданне CSS Каментары

Даданне CSS каментар даволі лёгка. Вы проста фарзац свой каментар з правільнымі тэгамі адкрыцця і закрыцця каментарыяў:

Усё, што з'яўляецца паміж гэтымі двума тэгамі будзе утрыманнем каментара, бачнае толькі ў кодзе і не адлюстроўваецца ў браўзэры.

CSS-каментар можа быць у адным радку, ці гэта можа заняць некалькі радкоў. Вось адзін прыклад радкі:

DIV # border_red {мяжа: тонкі цвёрды чырвоны; } / * Чырвоная аблямоўка прыклад * /

І шматрадковы прыклад:

/ *************************** ********************** ****** Стыль для кода тэксту **************************** ************ *************** /

ўспыхваюць Раздзелы

Адзін са спосабаў, я часта выкарыстоўваю CSS каментары арганізаваць маю табліцу стыляў у больш дробных, лёгка disgestible кавалках. Я хацеў бы мець магчымасць лёгка бачыць гэтыя раздзелы, калі я прагартаць файл пазней. Каб зрабіць гэта, я часта дадаваць каментары з вялікай колькасцю рысачак у іх так, што яны забяспечваюць вялікія, відавочныя парывы ​​на старонцы, якія лёгка ўбачыць, як я хутка пракручваць код. Вось прыклад:

/ * ----------------------- Загаловак Стылі ----------------------- ------- * /

Калі я бачу адну з гэтых каментароў у маім кодзе, я ведаю, што гэта пачатак новага падзелу гэтага дакумента, што дазваляе мне лёгка апрацоўваць і выкарыстоўваць код.

& # 34; закаментаваўшы & # 34; код

Тэгі каментароў таксама могуць быць карысныя ў рэальным працэсе кадавання і адладкі старонкі. Каментары могуць быць выкарыстаны для «закаментаваць» або «выключыць» вобласць гэтага кода, каб паглядзець, што адбудзецца, калі гэты падзел не з'яўляецца часткай старонкі.

Так як жа гэта працуе? Ну, таму што каментар тэгі паведамляюць браўзэру, каб ігнараваць усе паміж імі, вы можаце выкарыстоўваць іх, каб часова адключыць некаторыя часткі кода CSS. Гэта можа быць карысна пры адладцы або пры наладзе вэб-старонцы фарматавання.

Каб зрабіць гэта, вы б проста дадаць адкрыццё тэг каментара, дзе вы хочаце, каб код для запуску можа быць адключаны, а затым змясціць што заканчэнне тэг туды, дзе інваліды частка да канца. Ўсё паміж гэтымі тэгамі не будзе ўплываць на візуальнае адлюстраванне сайта, што дазваляе адладжваць CSS, каб убачыць, дзе праблема можа быць. Затым вы можаце пайсці і выправіць толькі гэтую праблему і выдаліць каментары з кода.

CSS Каментуючы парады

Як рэзюмаваць, вось некалькі саветаў, каб памятаць для выкарыстання каментароў у CSS:

  1. Каментары могуць займаць некалькі радкоў.
  2. Каментары могуць ўключаць CSS элементы, якія вы не хочаце, якiя аказваюцца ў браўзэры, але не хочаце, каб цалкам выдаліць. Гэта добры спосаб адладкі табліцы стыляў вэб-сайта - толькі не забудзьцеся выдаліць невыкарыстоўваныя стылі (у адрозненне ад Пакіданне іх закаментаваўшы), калі вы вырашыце, што вам не трэба іх на вэб-сайце
  3. Выкарыстоўвайце каментары кожны раз, калі вы пішаце складаны CSS, каб дадаць ўдакладненне і інфармаваць будучыя распрацоўшчык, ці сябе ў будучыні, пра важныя рэчы, якія яны павінны ведаць. Гэта дазволіць зэканоміць будучы час развіцця для ўсіх удзельнікаў.
  4. Каментары могуць таксама ўключаць у сябе мета інфармацыю, як:
    • аўтар
    • даце стварэння
    • інфармацыя аб аўтарскіх правах

прадукцыйнасць

Каментары, безумоўна, могуць быць карыснымі, але майце ў выглядзе, што чым больш каментароў, дадаваных ў табліцу стыляў, то яна будзе аб'ёмным багаж стане, якая будзе ўплываць на хуткасць загрузкі на сайце і прадукцыйнасць. Гэта рэальная праблема, але вы не павінны вагацца, каб дадаць карысныя і законныя каментары, баючыся, што прадукцыйнасць будзе пакутаваць. Лініі CSS ня дадаюць істотнага памеру да дакумента. Вы павінны былі б дадаць Тон радкоў каментароў, каб зрабіць істотны ўплыў на памер файла CSS. Даданне некалькі карысных заўваг у ваш CSS не павінна даць вам чыстае адмоўнае ўплыў на хуткасці старонкі.

У рэшце рэшт, вы хочаце, каб знайсці баланс паміж карыснымі каментарамі і занадта шмат каментароў, каб атрымаць перавагу як у вашых CSS дакументах.

Арыгінал артыкула Джэніфер Krynin. Пад рэдакцыяй Джэрэмі Girard на 7/5/17