HTML с нуля: Комментарий в HTML. Урок №24


Привет, друзья!

Как веб-разработчик, который работает с сайтами, скриптами и плагинами, я часто использую комментарии в коде, чтобы облегчить себе дальнейшую работу. Комментирование — это обязательный элемент, который стоит учитывать, независимо от того, пишете ли вы код в одиночку или работаете в команде.

Итак, зачем вообще добавлять комментарии в HTML?

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

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





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

<!-- Это комментарий -->

Всё, что размещено между этими тегами, будет проигнорировано браузером, но даст полезную информацию разработчику. Например:

<html>
<head>
<title>Как добавлять комментарии в HTML</title>
</head>
<body>
<!-- Это шапка сайта -->
<img src="heder.png">
 
<!-- Контент -->
<p>Комментарии в HTML на сайте overcod.net</p>
</body>
</html>

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

Теперь о том, что я обещал в начале: как временно отключать часть кода с помощью комментариев. Это — ещё одна важная причина использовать их в практике.

Иногда бывает полезно, если в какой-то момент блок кода вам не нужен, но в будущем он снова может понадобиться. Вместо того чтобы удалять его и потом заново восстанавливать, проще закомментировать его. Пример:

<!-- Шапка сайта
<img src="heder.png">
-->
<!-- Контент -->
<p>Комментарии в HTML на сайте overcod.net</p>

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

Итак, вот вам главный совет: всегда комментируйте код! Не забывайте, что мозг — это не чемодан, и всё в нём не уместить. Лучше потратить пару секунд на комментарий, чем потом тратить много времени на то, чтобы вспомнить, что вы сделали.