Коли ви переглядаєте веб-сторінку в переглядачі, ви бачите візуальне уявлення того, що ця частина програмного забезпечення (веб-браузер) відображає на основі коду конкретної веб-сторінки. Якщо ви переглядаєте цей вихідний код веб-сторінки, ви побачите документ, що складається з різних елементів HTML, включаючи абзаци, заголовки, списки, посилання, зображення та багато іншого. Всі ці елементи відображаються переглядачем на екрані відвідувача як частина відображення веб-сайту. Одна річ, яку ви можете знайти в HTML-коді, який не відображається на екрані людини, це те, що відомо як «HTML-коментарі».
Що таке коментар?
Коментар - це рядок коду в HTML, XML або CSS, який не переглядається і не обробляється браузером або аналізатором. Він просто записується в код, щоб надати інформацію про цей код або інші відгуки розробників коду.
Більшість мов програмування мають коментарі, вони зазвичай використовуються розробником коду з однієї або навіть більше, з наступної причини:
- Опишіть і поясніть складний код тому, кому, можливо, доведеться попрацювати над ним у майбутньому - включаючи себе! Вони можуть повернутися до коду 3, 6 або 12 місяців потому і не пам'ятати, чому вони щось зробили певним чином. Коментарі можуть допомогти відповісти на їхні запитання і нагадати їм, де вони перебували, коли вперше розробляли цю сторінку.
- Дайте детальну інформацію про те, коли код було відредаговано або перевірено. Це може бути корисною інформацією і поводитися як журнал розробки, коли сайт востаннє працював.
- Вилучіть розділи коду, але залиште їх доступними для подальшого використання. Це часто робиться під час тестування та налагодження сайту. Якщо у вас є проблема на сайті, і ви не знаєте, що її викликає, ви можете закомментувати розділи по одному, щоб ізолювати і ідентифікувати проблему, а потім попрацювати над виправленням будь-яких проблем, які у вас виникли.
- Спілкуйтеся з іншими розробниками, які працюють над кодом. Швидше за все, це буде зроблено під час розробки як спосіб поділитися деталями з іншими, що працюють над кодом одночасно. Якщо ці коментарі є суто розмовами про розробку, рекомендується видалити їх з коду перед запуском сайту.
Традиційно коментарі в HTML використовуються практично для будь-яких елементів, від пояснень складних структур таблиць до інформативних зауважень про зміст самої сторінки. Оскільки коментарі не відображаються в переглядачі, ви можете додавати їх у будь-яке місце HTML-коду і не турбуватися про те, що він робитиме, коли користувач переглядає сайт.
Як писати коментарі
Написання коментарів у HTML, XHTML і XML дуже легко.
Коментарі починаються з «менше ніж символ», плюс знак оклику і дві чорточки. Коментар закінчується двома чорточками та символом «більше ніж». Між цими символами ви можете написати все, що хочете, щоб скласти текст коментаря.
У CSS все трохи по-іншому, використовуючи коментарі коду на C, а не HTML. Ви починаєте з косої межі, за якою йде зірочка. Ви закінчуєте коментар зворотним знаком, зірочкою, за якою слідує коса риса.
/ * Приклад коментаря CSS */
Коментарі - вмираюче мистецтво
Більшість програмістів знають цінність корисних коментарів. Закомментований код полегшує передачу цього коду від одного члена команди іншому. Коментарі допомагають вашій команді QA протестувати код, тому що вони можуть сказати, що розробник мав намір - навіть якщо цього не було досягнуто. На жаль, через популярність платформ для створення веб-сайтів, таких як WordPress, які дозволяють вам працювати з обраною темою, яка обробляє більшу частину, якщо не весь, HTML для вас, коментарі не використовуються веб-командами так часто. Це тому, що коментарі дійсно важко побачити у більшості інструментів візуального редагування, якщо ви не працюєте безпосередньо з кодом.
Що можна зробити, якщо ви розробник?
- Пишіть змістовні та корисні коментарі. Не очікуйте, що інші люди читатимуть ваші коментарі, якщо вони занадто довгі або не містять корисної інформації.
- Як розробник, ви завжди повинні переглядати будь-які коментарі, які ви бачите на сторінці.
- Використовуйте інструменти, надані авторськими програмами, які дозволяють додавати коментарі.
- Використовуйте керування контентом, щоб контролювати, як редагуються сторінки.
Навіть якщо ви єдина людина, яка редагує ваші веб-сторінки, коментарі можуть бути корисні. Якщо ви редагуєте складну сторінку лише раз на рік, легко забути, як ви створювали таблицю або збирали CSS. З коментарями вам не потрібно запам'ятовувати, оскільки це написано прямо для вас.