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