Menu

Komentarze w HTML: składnia, wiele linii i skróty

Komentarz HTML to tekst między <!-- i -->, którego przeglądarka nie wyświetla. Poznaj składnię, komentarze wieloliniowe, zakomentowywanie kodu, skrót w edytorze, powód, dla którego komentarzy nie da się zagnieżdżać, i dlaczego nigdy nie są prywatne.

Na tej stronie są działające edytory: edytuj, uruchamiaj i od razu zobacz wynik.

Jak napisać komentarz w HTML

Komentarz HTML zaczyna się od <!-- i kończy na -->. Przeglądarka ignoruje wszystko między tymi znacznikami, więc tekst nigdy nie pojawia się na stronie:

Wyświetlają się tylko nagłówek i akapit. HTML ma jedną składnię komentarzy i działa ona zarówno dla jednej linii, jak i wielu.

Skrót w VS Code i większości edytorów: zaznacz kilka linii i naciśnij Ctrl + / (Cmd + / na Macu). Edytor doda znaczniki za ciebie, a te same klawisze je usuwają.

Zakomentowywanie kodu

Przeglądarka ignoruje znaczniki wewnątrz komentarza, więc otoczenie kodu przez <!-- i --> ukrywa go bez usuwania. To najszybszy sposób, żeby przetestować stronę bez jakiegoś elementu:

Usuń <!-- i --> w linii z banerem, a pojawi się z powrotem. Zakomentowany kod nadal jest pobierany razem ze stroną, więc gdy masz pewność, że go nie potrzebujesz, usuń go.

Komentarzy nie da się zagnieżdżać

Pierwsze --> zawsze zamyka komentarz. Jeśli zakomentowywany kod zawiera już komentarz, zewnętrzny komentarz kończy się za wcześnie, a reszta wylewa się na stronę. Ten przykład przekazuje zagnieżdżone komentarze parserowi przeglądarki i pokazuje, co zostaje widoczne:

still meant to be hidden --> wyświetla się jako tekst. Zanim zakomentujesz duży blok, usuń komentarze w jego wnętrzu (albo zmień ich -->, żeby przestało pasować).

Jeszcze kilka zasad: komentarz nie może zaczynać się od <!--> (to pusty komentarz, więc to, co po nim, jest widoczne), a --!> zamyka komentarz tak samo jak -->, więc nie umieszczaj żadnego z nich w treści komentarza.

Komentarze są publiczne

Komentarze są częścią HTML wysyłanego przez serwer, więc każdy odwiedzający może je przeczytać przez Wyświetl źródło lub narzędzia deweloperskie. Skrypt też może je wypisać:

Ograniczaj komentarze do notatek o kodzie. Nic prywatnego (hasła, klucze API, wewnętrzne adresy URL, dane klientów) nie może znaleźć się w HTML, zakomentowane czy nie. Narzędzia do budowania i minifikatory zwykle usuwają komentarze z produkcyjnego HTML, co przy okazji oszczędza kilka bajtów.

Komentarze w CSS i JavaScripcie

Komentarze HTML działają tylko w HTML. W <style> i <script> używasz składni komentarzy danego języka:

Nagłówek robi się niebieski: CSS ignoruje same znaczniki <!-- i --> i nadal stosuje regułę między nimi. Tylko /* ... */ wyłącza CSS. Tę składnię opisuje strona komentarze w CSS.

Komentarze warunkowe

W starym kodzie czasem pojawia się <!--[if IE]> ... <![endif]-->. Były to instrukcje dla Internet Explorera 9 i starszych. Każda obecna przeglądarka traktuje je jak zwykłe komentarze, więc treść w środku jest ignorowana i cały blok można usunąć.

Częste błędy

  • Zagnieżdżanie komentarzy. Wewnętrzne --> kończy zewnętrzny komentarz. Usuń wewnętrzne komentarze, zanim zakomentujesz blok.
  • Sekrety w komentarzach. Komentarze trafiają do każdego odwiedzającego.
  • Brak -->. Wszystko od <!-- do końca pliku znika, co wygląda, jakby zniknęła połowa strony.
  • Używanie <!-- --> w CSS. Nie wyłącza reguł. Użyj /* */.
  • Używanie // w HTML. // note wyświetla się jako tekst. HTML rozumie tylko <!-- -->.

Najczęściej zadawane pytania

Jak napisać komentarz w HTML?

Zacznij go od <!-- i zakończ -->: <!-- This is a comment -->. Przeglądarka ignoruje wszystko między tymi znacznikami, łącznie ze znacznikami HTML, więc ta sama składnia służy do zakomentowywania kodu.

Jak zrobić komentarz wieloliniowy w HTML?

HTML ma tylko jedną składnię komentarzy i może ona obejmować dowolnie wiele linii. Umieść <!-- w pierwszej linii, a --> po ostatniej.

Jaki jest skrót do komentowania w HTML?

W VS Code i większości edytorów kodu zaznacz linie i naciśnij Ctrl + / (Windows i Linux) lub Cmd + / (Mac). Edytor otacza zaznaczenie przez <!-- i -->, a te same klawisze je usuwają.

Czy komentarze HTML można zagnieżdżać?

Nie. Pierwsze --> kończy komentarz, więc w <!-- a <!-- b --> c --> tekst c --> wyświetla się na stronie. Aby zakomentować blok, który zawiera komentarz, najpierw usuń lub zmień komentarz wewnętrzny.

Czy użytkownicy widzą komentarze HTML?

Nie są wyświetlane, ale trafiają do przeglądarki razem ze stroną. Każdy może je przeczytać przez Wyświetl źródło lub narzędzia deweloperskie, więc nigdy nie umieszczaj w nich haseł, kluczy ani prywatnych notatek.

Czy komentarze HTML działają w CSS lub JavaScripcie?

Nie. W elemencie <style> używaj /* ... */, a w <script> używaj // lub /* ... */. Komentarz HTML w bloku stylów nie ukrywa reguł CSS w środku.

Ilustracja języków programowania w Coddy

Ucz się programowania z Coddy

ZACZNIJ