Як додати коментарі до вашого 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:

• Коментарі можуть бути у декілька рядків.
• Використовуйте коментарі, щоб задокументувати розвиток вашої сторінки.
• Коментарі також можуть документувати вміст, рядки або стовпчики таблиці, відслідковувати зміни або що завгодно.
• Коментарі, які «вимикають» області сайту, не повинні перетворювати його на робочий, якщо тільки ця зміна не є тимчасовою, яка буде скасована в короткі терміни (наприклад, при включенні або відключенні попереджувального повідомлення при необхідності).