Якія HTML Каментары і як яны выкарыстоўваюцца
aWhen праглядаць вэб-старонкі ў браўзэры, вы бачыце візуальнае ўяўленне пра тое, што частка праграмнага забеспячэння (вэб-браўзэра), размяшчаючы на аснове кода канкрэтнай вэб-старонкі. Калі паглядзець , што зыходны код вэб - старонкі, вы ўбачыце дакумент, які складаецца з розных HTML - элементаў, у тым ліку пункты, загалоўкі, спісы, спасылкі, малюнкі і многае іншае. Усе гэтыя элементы адлюстроўваюцца ў браўзэры на экране наведвальніка ў частцы адлюстравання вэб-сайта. Адна рэч, якую вы можаце знайсці ў HTML код, які не адлюстроўваецца на экране чалавека тое, што вядома як «HTML каментары».
Што такое каментар?
Каментар з'яўляецца радком кода ў HTML, XML або CSS, які не разглядаецца або які падвяргаецца дзеянню браўзэра або сінтаксічнага аналізу. Гэта проста напісана ў кодзе, каб даць інфармацыю аб тым, што код або іншай зваротнай сувязі ад распрацоўшчыкаў кода.
Большасць моў праграмавання маюць каментары, яны звычайна выкарыстоўваюцца распрацоўшчыкам кодэкса для аднаго ці нават больш, чым адзін, па наступных прычынах:
- Апісаць і растлумачыць складаны код, каб хтосьці, магчыма, прыйдзецца працаваць над гэтым ў будучыні - у тым ліку сябе! Яны могуць вярнуцца да кода 3 ці 6 да 12 месяцаў або пазнейшых і не памятаюць, чаму яны зрабілі нешта пэўным чынам. Каментары могуць дапамагчы адказаць на іх пытанні і нагадаць ім пра тое, дзе іх розуме быў, калі яны былі першай распрацоўкай гэтай старонкі.
- Прадаставіць падрабязную інфармацыю аб тым, калі код быў адрэдагаваны і не рэцэнзуюцца. Гэта можа быць карыснай інфармацыяй і дзейнічаць некалькі як часопіс развіцця, калі сайт быў апошнім працаваў.
- Выдаліць раздзелы кода, але пакінуць іх для далейшага выкарыстання. Гэта часта робіцца падчас тэставання сайта і адладкі. Калі ў вас ёсць праблемы на месцы і не ўпэўненыя ў тым, што з'яўляецца прычынай гэтага, вы можаце закаментаваць раздзелы па адным за раз, каб quarentine і ідэнтыфікаваць праблему, а затым працаваць над рашэннем любых праблем, якія вы маеце.
- Майце зносіны з іншымі распрацоўшчыкамі, якія працуюць над кодам. Гэта, верагодна, будзе зроблена ў ходзе развіцця як спосаб падзяліцца дэталямі з іншымі арганізацыямі, якія працуюць над кодам адначасова. Калі гэтыя каментары з'яўляюцца чыста развіццём гутаркі, гэта лепшая практыка, каб выдаліць іх з кода перад сайтам запушчаны.
Традыцыйна, каментары ў HTML выкарыстоўваюцца для амаль любых элементаў, ад тлумачэння складаных таблічных структур інфарматыўных заўваг пра змест самой старонкі. Паколькі каментары не адлюстроўваюцца ў браўзэры, вы можаце дадаць іх у любым месцы ў HTML і не турбавацца аб тым, што ён будзе рабіць, калі сайт разглядаецца заказчыкам.
Як пісаць каментары
Напісанне каментароў у HTML, XHTML і XML вельмі лёгка. Проста атачаюць тэкст, які вы хочаце закаментаваўшы з наступным:
і ->Як вы можаце бачыць, гэтыя каментары пачынаюцца з «менш, чым сімвал», а таксама кропкай exclaimation і два ціра. Каментар заканчваецца з яшчэ двума рысачкамі і «больш чым :. Сімвал Паміж гэтымі сімваламі Вы можаце напісаць усё, што вы хочаце, каб кампенсаваць цела каментара.
У CSS, гэта крыху па-іншаму, выкарыстоўваючы каментары кода C, а не HTML Вы пачынаюцца з касой рысы, за якім варта зорачкай. Вы сканчаеце каментар са зваротным што, зорачкай і касой рысай.
/ * Каментаваць тэкст * /Каментары з'яўляюцца паміранне Art
Большасць праграмістаў ведаюць каштоўнасць карысных заўваг . Адказаў код палягчае гэты код будзе перадавацца ад аднаго члена каманды да іншага. Каментары дапамогуць вам каманду QA праверыць код, таму што яны могуць сказаць, што распрацоўшчык прызначаны - нават калі яна не была дасягнутая. На жаль, з ростам папулярнасці вэб-авторинга платформаў, такіх як Wordpress, якія дазваляюць атрымаць і працуе з абранай тэмай, якая апрацоўвае шмат, калі не ўсё, у HTML для вас, каментары не выкарыстоўваюцца як часта вэб-каманд. Гэта таму, што каментары сапраўды цяжка ўбачыць у большасці інструментаў візуальнага рэдагавання, калі вы не працуеце непасрэдна з кодам. Напрыклад, замест таго, каб бачыць, у верхняй частцы вэб-старонкі:
Візуальны інструмент паказвае малюсенькі значок, які паказвае, што каментар ёсць. Калі дызайнер не фізічна адкрыць свой каментар, ён можа ніколі не ўбачыць. І ў выпадку названай вышэй старонцы, можа выклікаць праблемы, калі яна рэдагуе старонку і рэдагаванне перапісаныя з дапамогай сцэнарыя, згаданага ў каментары.
Што можна зрабіць?
- Напісаць змястоўныя і карысныя каментары. Не чакайце іншых людзей чытаць вашыя каментары, калі яны занадта доўга ці не ўключаць у сябе карысную інфармацыю.
- Як распрацоўшчык, вы заўсёды павінны разглядаць любыя каментары , якія Вы бачыце на старонцы.
- Выкарыстоўвайце сродкі, якія прадстаўляюцца праграмамі авторинга, якія дазваляюць дадаваць каментары.
- Выкарыстанне кіравання кантэнтам для кіравання, як старонкі рэдагуюцца.
Нават калі вы адзіны чалавек, які рэдагуе свае вэб-старонкі, каментары могуць быць карыснымі. Калі вы толькі рэдагаваць складаную старонку адзін раз у год, гэта лёгка забыцца, як вы пабудавалі табліцу ці сабраць CSS. З каментарамі, вы не павінны памятаць, як гэта напісана прама там для вас.
Арыгінал артыкула Джэніфер Krynin. Пад рэдакцыяй Джэрэмі Girard на 5/5/17