Как комментируется код при написании HTML?

Когда вы просматриваете веб-страницу в браузере, вы видите визуальное представление того, что эта часть программного обеспечения (веб-браузер) отображает на основе кода конкретной веб-страницы. Если вы просматриваете этот исходный код веб-страницы, вы увидите документ, состоящий из различных элементов HTML, включая абзацы, заголовки, списки, ссылки, изображения и многое другое. Все эти элементы отображаются браузером на экране посетителя как часть отображения веб-сайта. Одна вещь, которую вы можете найти в HTML-коде, который не отображается на экране человека, это то, что известно как «HTML-комментарии».

Что такое комментарий?

Комментарий — это строка кода в HTML, XML или CSS, которая не просматривается и не обрабатывается браузером или анализатором. Он просто записывается в код для предоставления информации об этом коде или других отзывов разработчиков кода.

Большинство языков программирования имеют комментарии, они обычно используются разработчиком кода по одной или даже нескольким причинам по следующей причине:

• Опишите и объясните сложный код тому, кому, возможно, придется поработать над ним в будущем — включая себя! Они могут вернуться к коду 3, 6, 12 или более месяцев спустя и не помнить, почему они что-то сделали определенным образом. Комментарии могут помочь ответить на их вопросы и напомнить им о том, где они находились, когда разрабатывали эту страницу.
• Предоставьте подробную информацию о том, когда код был отредактирован или проверен. Это может быть полезной информацией и вести себя как журнал разработки, когда сайт в последний раз работал.
• Удалите разделы кода, но оставьте их доступными для последующего использования. Это часто делается во время тестирования и отладки сайта. Если у вас есть проблема на сайте и вы не знаете, что ее вызывает, вы можете закомментировать за один раз разделы, чтобы изолировать и идентифицировать проблему, а затем поработать над решением любых проблем, которые у вас возникли.
• Общайтесь с другими разработчиками, работающими над кодом. Скорее всего, это будет сделано во время разработки как способ поделиться деталями с другими, работающими над кодом одновременно. Если эти комментарии являются чисто разговорами о разработке, рекомендуется удалить их из кода перед запуском сайта.

Традиционно комментарии в HTML используются практически для любых элементов, от объяснений сложных структур таблиц до информативных замечаний о содержании самой страницы. Поскольку комментарии не отображаются в браузере, вы можете добавлять их в любом месте HTML-кода и не беспокоиться о том, что он будет делать, когда сайт просматривает клиент.

Как писать комментарии

Написание комментариев в HTML, XHTML и XML очень легко.

Комментарии начинаются с «меньше чем символ», плюс восклицательный знак и две черточки. Комментарий заканчивается еще двумя черточками и символом «больше чем». Между этими символами вы можете написать все, что хотите, чтобы составить текст комментария.

В CSS все немного по-другому, используя комментарии кода C, а не HTML. Вы начинаете с косой черты, за которой следует звездочка. Вы заканчиваете комментарий обратным знаком, звездочкой, за которой следует косая черта.

Комментарии — умирающее искусство

Большинство программистов знают ценность полезных комментариев. Закомментированный код облегчает передачу этого кода от одного члена команды другому. Комментарии помогают вашей команде QA протестировать код, потому что они могут сказать, что разработчик намеревался — даже если это не было достигнуто. К сожалению, из-за популярности платформ для создания веб-сайтов, таких как WordPress, которые позволяют вам работать с выбранной темой, которая обрабатывает большую часть, если не весь, HTML для вас, комментарии не используются веб-командами так часто. Это потому, что комментарии действительно трудно увидеть в большинстве визуальных средств разработки, если вы не работаете непосредственно с кодом. 

Что можно сделать, если вы разработчик?

1. Пишите содержательные и полезные комментарии. Не ожидайте, что другие люди будут читать ваши комментарии, если они слишком длинные или не содержат полезной информации.
2. Как разработчик, вы должны всегда просмотрите любые комментарии, которые вы видите на странице.
3. Используйте инструменты, предоставленные авторскими программами, которые позволяют добавлять комментарии.
4. Используйте управление контентом, чтобы контролировать редактирование страниц.

Даже если вы единственный человек, который редактирует ваши веб-страницы, комментарии могут быть полезны. Если вы редактируете сложную страницу только один раз в год, легко забыть, как вы создали таблицу или собрали CSS. С комментариями вам не нужно запоминать, поскольку это написано прямо для вас.