Кои се HTML-коментарите и како се користат
aКога ќе видите веб-страница во прелистувачот, гледате визуелна претстава за тоа што дел од софтверот (веб-прелистувачот) се прикажува врз основа на кодот на одредена веб-страница. Ако го гледате тој изворен код на веб-страницата, ќе видите документ составен од различни HTML елементи, вклучувајќи ставови, наслови, списоци, линкови, слики и друго. Сите овие елементи ги прикажува прелистувачот на екранот на посетителот како дел од приказот на веб-страницата. Една работа што може да ја најдете во HTML кодот што не е изречена на екранот на лицето е она што се познати како "HTML коментари".
Што е коментар?
Коментар е низа кодови во рамките на HTML, XML или CSS што не е прегледано или постапено од страна на прелистувачот или парсерот. Едноставно е напишано во кодот за да обезбеди информации за тој код или други повратни информации од развивачите на код.
Повеќето програмски јазици имаат коментари, тие обично се користат од страна на развивачот на кодот за една или повеќе од една, од следната причина:
- Опишете и објаснете комплициран код за некој кој можеби ќе треба да работи на него во иднина - вклучувајќи ги и самите себе! Тие можат да се вратат на код 3 или 6 од 12 месеци или повеќе подоцна и не се сеќаваат зошто тие направиле нешто на одреден начин. Коментарите можат да помогнат да одговорат на нивните прашања и да ги потсетат на тоа каде нивниот ум е кога тие првпат ја развиле таа страница.
- Дајте детали за тоа кога кодот е изменет или прегледан. Ова може да биде корисна информација и да дејствува нешто како лого за развој на некоја локација на која последен пат работеле.
- Отстрани делови од кодот, но оставете ги достапни за подоцнежна употреба. Ова често се прави за време на тестирање и дебагирање. Ако имате проблем на веб-страница и не сте сигурни што предизвикува тоа, можете да ги коментирате секциите од една во друга за кварентинот и да го идентификувате проблемот, а потоа да работите на фикс за какви било проблеми што ги имате.
- Разговарајте со други развивачи кои работат на кодот. Ова, најверојатно, ќе биде направено за време на развојот како начин да споделувате детали со другите кои работат на кодот во исто време. Ако овие коментари се чисто разговори за развој, најдобро е да ги отстраните од кодот пред да се започне со сајт.
Традиционално, коментарите во HTML се користат за речиси сите елементи, од објаснувања на комплексните структури на табели до информативни забелешки на содржината на самата страница. Бидејќи коментарите не се прикажани во прелистувачот, можете да ги додадете било каде во HTML и немате загриженост за тоа што ќе стори кога страната ќе ја гледа клиентот.
Како да пишувам коментари
Пишувањето коментари во HTML, XHTML и XML е многу лесно. Едноставно опкружувајте го текстот што сакате да го коментирате со следново:
и ->Како што можете да видите, овие коментари започнуваат со "помалку од симбол", плус точка на извинување и две цртички. Коментарот завршува со уште две цртички и "поголем од: симбол. Меѓу овие ликови можете да напишете што сакате да го сочините телото на коментарот.
Во CSS, тоа е малку поинакво, користејќи ги коментарите на C кодот, наместо HTML. Започнувате со коса црта, проследена со ѕвездичка. Вие го завршите коментарот со обратното од тоа, ѕвездичка проследена со коса црта.
/ * коментиран текст * /Коментари се умира уметност
Повеќето програмери ја знаат вредноста на корисни коментари . Коментираниот код го олеснува префрлањето на тој код од еден член на тимот во друг. Коментарите ви помагаат на ОК тимот за тестирање на кодот, бидејќи тие можат да кажат што планирал инвеститорот - дури и ако тоа не е постигнато. За жал, со популарноста на платформите за авторизација на веб-сајтови како Wordpress, кои ви дозволуваат да станете и да работите со избрана тема која што се справува со многу, ако не и сите, HTML за вас, коментарите не се користат толку често од веб-тимови. Ова е затоа што коментарите навистина се тешки за гледање во повеќето визуелни алатки за авторизација ако не работите директно со кодот. На пример, наместо да гледате, на врвот на веб страница:
Визуелната алатка покажува мала икона за да укаже дека постои коментар. Ако дизајнерот физички не го отвори коментарот, тој никогаш нема да го види. И во случај на горенаведената страница, може да предизвика проблеми ако ја уредува страницата и дека уредувањето е надпишано од сценариото споменато во коментарот.
Што може да се направи?
- Напишете значајни и корисни коментари. Не очекувајте други луѓе да ги прочитаат вашите коментари ако се премногу долги или не вклучуваат корисни информации.
- Како развивач, секогаш треба да ги разгледате сите коментари што ги гледате на една страница.
- Користете алатки обезбедени од програмите за пишување кои ви дозволуваат да додавате коментари.
- Користете управување со содржини за да контролирате како се уредуваат страниците.
Дури и ако сте единствената личност која ги уредува вашите веб-страници, коментарите може да бидат корисни. Ако само уредувате комплицирана страница еднаш годишно, лесно е да се заборави како сте ја изградиле табелата или го составиле CSS. Со коментари, не треба да се сеќавате, бидејќи е напишано токму за вас.
Авторски напис од Џенифер Крајнин. Редаван од Џереми Гирард на 5/5/17