Как добавить комментарии в ваш HTML

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

Как добавить комментарии HTML

HTML может быть создан с помощью стандартного текстового редактора, такого как Notepad ++ для Windows или TextEdit для Mac. Вы также можете использовать программу, ориентированную на веб-дизайн, такую ​​как Adobe Dreamweaver, или даже платформу CMS, такую ​​как WordPress или ExpressionEngine. Независимо от инструмента, который вы используете для создания HTML, если вы работаете непосредственно с кодом, вы бы добавили HTML-комментарии следующим образом:

  1. Добавьте первую часть тега HTML-комментария:

  2. После этого вступительного комментария напишите любой текст, который вы хотели бы видеть для этого комментария. Это может быть инструкция для вашего или другого разработчика в будущем. Например, если вы хотите указать, где определенный раздел на странице начинается или заканчивается в разметке, вы можете использовать комментарий, чтобы уточнить это.

  3. Как только текст вашего комментария будет завершен, закройте тег комментария следующим образом:

  4. В итоге ваш комментарий будет выглядеть примерно так:

  5. Это действительно так просто.

Отображение комментариев

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

Комментарии для целей тестирования

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

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

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

Относительно производительности

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

Советы по использованию комментариев

Несколько вещей, о которых следует помнить или помнить при использовании комментариев HTML:

  • Комментарии могут быть в несколько строк.
  • Используйте комментарии, чтобы задокументировать развитие вашей страницы.
  • Комментарии также могут документировать содержимое, строки или столбцы таблицы, отслеживать изменения или что угодно.
  • Комментарии, которые «отключают» области сайта, не должны превращать его в рабочий, если только это изменение не является временным, которое будет отменено в короткие сроки (например, при включении или отключении предупреждения при необходимости).
Оцените статью
Solutics.ru
Добавить комментарий