Когато преглеждате уеб страница в браузър, виждате визуално представяне на това, което този софтуер (уеб браузър) показва на базата на кода на конкретна уеб страница. Ако видите този изходен код на уеб страницата, ще видите документ, съставен от различни HTML елементи, включително параграфи, заглавия, списъци, връзки, изображения и др. Всички тези елементи се предават от браузъра на екрана на посетителя като част от показването на уебсайта. Едно нещо, което може да откриете в HTML кода, който не се изобразява на екрана на човека, е това, което се нарича "HTML коментар".
Какво е коментар?
Коментарът е низ от код в HTML, XML или CSS, който не се разглежда или не се изпълнява от браузъра или анализатора. Тя просто е написана в кода, за да предостави информация за този код или друга обратна връзка от разработчиците на кодове.
Повечето езици за програмиране имат коментари, те обикновено се използват от разработчика на кода за една или дори повече от една от следните причини:
- Опишете и обяснете сложен код на някой, който може би ще трябва да работи върху него в бъдеще - включително себе си! Те могат да се върнат на код 3 или 6 от 12 месеца или повече по-късно и да не помнят защо са направили нещо по определен начин. Коментарите могат да помогнат да отговорят на въпросите им и да им напомнят къде е умът им при първото разработване на тази страница.
- Посочете подробности кога кода е бил редактиран или прегледан. Това може да е полезна информация и да действа малко като дневник за разработка на последния работен сайт.
- Премахнете секции от кода, но ги оставяйте достъпни за по-късна употреба. Това често се прави по време на тестване и отстраняване на грешки в сайта. Ако имате проблем на даден сайт и не сте сигурни какво го причинява, можете да коментирате отделни секции едно по едно, за да поставите в карантина и да идентифицирате проблема и след това да работите по корекция за каквито и да е проблеми.
- Разговаряйте с други програмисти, работещи по кода. Това вероятно ще бъде направено по време на разработката като начин за споделяне на детайли с другите, работещи по кода по същото време. Ако тези коментари са чисто развойни разговори, най-добрата практика е да ги премахнете от кода, преди да започне даден сайт.
Традиционно коментарите в HTML се използват за почти всички елементи, от обяснения на сложни таблични структури до информативни забележки за съдържанието на самата страница. Тъй като коментарите не се изобразяват в браузъра, можете да ги добавите навсякъде в HTML и да не се притеснявате какво ще направи, когато сайтът бъде прегледан от клиент.
Как да напиша коментари
Писането на коментари в HTML, XHTML и XML е много лесно. Просто заобикаляйте текста, който искате да коментирате със следното:
и
Както можете да видите, тези коментари започват с "по-малко от символ", плюс възклицание и две тирета. Коментарът завършва с още две тирета и символ "по-голям от :. Между тези знаци можете да напишете каквото искате да натрупате от тялото на коментара.
В CSS, това е малко по-различно, като се използват кодовете на C код, а не HTML. Започвате с наклонена черта, последвана от звездичка. Завършвате коментара с обратното, със звездичка, последвана от наклонена черта.
Коментарите са умиращо изкуство
Повечето програмисти знаят колко полезни са коментарите. Коментираният код улеснява прехвърлянето на този код от един член на екип в друг. Коментарите Ви помагат да проверите кода, защото те могат да разберат какво е предназначен за програмиста, дори и да не е постигнато. За съжаление, с популярността на платформите за създаване на уебсайтове като Wordpress, които ви позволяват да стартирате и работите с избрана тема, която обработва много, ако не и всички, на HTML за вас, коментарите не се използват толкова често от уеб екипите. Това е така, защото коментарите са трудно видими в повечето инструменти за визуално създаване, ако не работите директно с кода. Например, вместо да виждате, в горната част на уеб страница:
Визуалният инструмент показва малка икона, която показва, че има коментар. Ако дизайнерът не отвори коментара физически, той никога няма да го види. И в случая на горната страница, може да причини проблеми, ако тя редактира страницата и тази редакция е надписана от скрипта, споменат в коментара.
Какво може да се направи?
- Напишете смислени и полезни коментари. Не очаквайте други хора да четат коментарите ви, ако са твърде дълги или не съдържат полезна информация.
- Като разработчик, трябва винаги прегледайте коментарите, които виждате на страницата.
- Използвайте инструментите, предоставени от програмите за авторство, които ви позволяват да добавяте коментари.
- Използвайте управлението на съдържанието, за да контролирате редактирането на страниците.
Дори и да сте единственият човек, който редактира уеб страниците ви, коментарите могат да ви бъдат полезни. Ако редактирате сложна страница само веднъж годишно, лесно можете да забравите как сте съставили таблицата или сте съставили CSS. С коментарите, не е нужно да си спомняте, тъй като е написано точно за вас.
