Jak dodać komentarz w HTML?

Dodawanie komentarzy w HTML

Aby dodać komentarz w HTML, należy użyć specjalnych znaczników otwierających i zamykających: <!-- na początku komentarza i --> na końcu. Każdy tekst umieszczony pomiędzy tymi znacznikami jest ignorowany przez przeglądarkę i nie wyświetla się na stronie, ale jest widoczny w kodzie źródłowym dla programistów oraz osób analizujących stronę.

Składnia komentarza w HTML

<!-- To jest komentarz w HTML --> 

• Komentarz rozpoczyna się sekwencją <!--,
• treść komentarza może zawierać dowolny tekst,
• komentarz kończy się sekwencją -->,
• przeglądarka zupełnie pomija tekst komentarza podczas renderowania strony.

Przykłady zastosowań komentarzy w HTML

1. Wyjaśnienia w kodzie

Komentarze pomagają wyjaśnić, do czego służą poszczególne elementy strony, co ułatwia jej rozwijanie i utrzymanie:

<!-- Sekcja nagłówka strony -->
<header>
  <h1>Moja wizytówka</h1>
</header>

2. Tymczasowe ukrycie fragmentu kodu

Przydatne podczas testowania różnych rozwiązań – można „wyłączyć” część kodu bez trwałego usuwania:

<!--
<nav>
  <ul>
    <li>Strona główna</li>
    <li>Kontakt</li>
  </ul>
</nav>
-->

3. Oznaczenia pomocnicze w dużych plikach

Komentarze porządkują strukturę dokumentu, pozwalając szybko odnaleźć odpowiednie sekcje:

<!-- === Początek sekcji artykułów === -->
<main>
  <!-- Artykuł pierwszy -->
  <article>...</article>
  <!-- Artykuł drugi -->
  <article>...</article>
</main>
<!-- === Koniec sekcji artykułów === -->

4. Informacje dla współpracowników

Komentarze mogą zawierać wskazówki lub notatki, które mają być pomocne dla innych osób pracujących nad tym samym projektem:

<!-- TODO: Zamienić obrazek na wersję responsywną -->
<img src="stary-obrazek.jpg" alt="Logo">

Dobre praktyki dotyczące komentarzy w HTML

• Nie używaj zbyt wielu komentarzy w produkcyjnej wersji strony – wydłużają one kod źródłowy i mogą ujawniać wrażliwe informacje.
• Komentarze nie są widoczne dla użytkownika na stronie, ale każdy może je zobaczyć, przeglądając kod strony.
• Unikaj umieszczania w komentarzach znaków --, ponieważ nie są one obsługiwane zgodnie ze specyfikacją HTML (w szczegółowych przypadkach mogą powodować błędy parsowania).

Podsumowanie najważniejszych zastosowań –

• Dokumentacja kodu – ułatwienie pracy zespołowej i samodzielnych poprawek;
• Ukrywanie fragmentów podczas testowania – szybka dezaktywacja elementów bez ich usuwania;
• Porządkowanie struktury pliku – lepsza orientacja w dużych dokumentach HTML.

Podstawowy schemat komentarza do wielokrotnego wykorzystania –

<!-- Komentarz -->