Правильно прокомментировано 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:
- Комментарии могут состоять из нескольких строк.
- Используйте комментарии, чтобы задокументировать развитие вашей страницы.
- Комментарии также могут документировать содержимое, строки или столбцы таблицы, отслеживать изменения или что угодно.
- Комментарии, которые «отключают» области сайта, не должны использоваться в рабочей среде, если это изменение не является временный, который будет отменен в короткие сроки (например, включение или отключение предупреждающего сообщения как нужный).