Правильно прокомментированная разметка HTML является важной частью хорошо построенной веб-страницы. Эти комментарии легко добавить, и каждый, кто должен работать над кодом этого сайта в будущем (включая вас или членов любой команды, с которой вы работаете), поблагодарит вас за эти комментарии.
Как добавить HTML-комментарии
HTML можно создать со стандартным текстовым редактором, например Notepad ++ для Windows или TextEdit для Mac. Вы также можете использовать веб-дизайн-ориентированную программу, такую как Adobe Dreamweaver или даже платформу CMS, например Wordpress или ExpressionEngine. Независимо от инструмента, который вы используете для написания HTML, если вы работаете непосредственно с кодом, вы бы добавили комментарии HTML следующим образом:
-
Добавьте первую часть тега комментария HTML:
-
Таким образом, ваш комментарий будет выглядеть примерно так:
-
Это действительно так просто.
Отображение комментариев
Любые комментарии, которые вы добавите в свой HTML-код, появятся в этом коде, когда кто-то просмотрит источник веб-страницы или откроет HTML в редакторе, чтобы внести некоторые изменения. Однако этот текст комментария не будет отображаться в веб-браузере, когда обычные посетители приходят на сайт. В отличие от других элементов HTML, включая абзацы, заголовки или списки, которые фактически влияют на страницу внутри этих браузеров, комментарии действительно «за кулисами» фрагментов страницы.
Комментарии для целей тестирования
Поскольку комментарии не отображаются в веб-браузере, их можно использовать для «отключения» частей страницы во время тестирования или разработки страницы. Если вы добавите открытую часть комментария непосредственно перед частью своей страницы / кода, которую хотите скрыть, а затем добавьте закрывающую часть в конце этого кода (комментарии HTML могут охватывать несколько строк, поэтому вы можете открыть прокомментируйте строку 50 вашего кода и закройте ее в строке 75 без проблем), то любые HTML-элементы, попадающие в этот комментарий, больше не будут отображаться в браузере. Они останутся в вашем коде, но не повлияют на визуальное отображение страницы. Если вам нужно проверить страницу, чтобы увидеть, вызывает ли какой-то раздел проблемы и т. Д., Комментируя эту область, предпочтительнее ее удалить. С комментариями, если раздел кода, о котором идет речь, не будет проблемой, вы можете легко удалить фрагменты комментария и этот код будет отображаться еще раз. Просто убедитесь, что эти комментарии, которые используются для тестирования, не попадают в производственные сайты.
Если область страницы не должна отображаться, вы хотите удалить код, а не просто прокомментировать его, прежде чем запускать этот сайт.
Одно замечательное использование комментариев HTML во время разработки - это когда вы создаете отзывчивый веб-сайт. Поскольку разные части этого сайта изменят внешний вид на разных размерах экрана, включая некоторые области, которые могут вообще не отображаться, использование комментариев для переключения секций страницы вкл или выкл может быть быстрым и легким трюком для использования во время разработки.
Что касается производительности
Я видел, как некоторые веб-профессионалы предполагают, что комментарии должны быть удалены из HTML и CSS-файлов, чтобы сократить размер этих файлов и создать страницы с более быстрой загрузкой. Хотя я согласен, что страницы должны быть оптимизированы для производительности и должны быстро загружаться, все еще есть место для умного использования комментариев в коде. Помните, что эти комментарии предназначены для облегчения работы на сайте в будущем, поэтому, если вы не просрочили его с комментариями, добавленными в каждую строку вашего кода, небольшое количество файлов, добавленных на страницу из-за комментарии должны быть более чем приемлемыми.
Советы по использованию комментариев
Несколько вещей, которые следует учитывать или помнить при использовании комментариев HTML:
- Комментарии могут быть несколькими строками.
- Используйте комментарии для документирования развития своей страницы.
- Комментарии также могут документировать содержимое, строки или столбцы таблицы, отслеживать изменения или что угодно.
- Комментарии, что «отключить» области сайта не должны вносить его в производство, если это изменение не является временным, которое будет отменено в короткие сроки (например, при необходимости включить или выключить предупреждающее сообщение).
