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>

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

Отже, ось вам головна порада: завжди коментуйте код! Не забувайте, що мозок — це не валіза, і все в ньому не вміститься. Краще витратити кілька секунд на коментар, ніж потім витрачати час на те, щоб згадати, що ви зробили.