Znaczenie poprawnego komentowania

Wystąpiły błędy skryptów na tej stronie. Mimo, że są one kierowane do redaktorów serwisu, można je częściowo przeglądać poniżej.

Znaczenie poprawnego komentowania

Podczas tworzenia HTML w trybie standardów, niepoprawnie sformatowane komentarze mogą zepsuć twe strony, powodując wykomentowanie części lub całości ich treści. Podczas tworzenia XHTML lub XML, niepoprawne komentarze spowodują, że twoje dokumenty nie będą mogły w ogóle zostać wyświetlone.

HTML 4.01

Z Rekomendacji W3C dla HTML 4.01, Sekcji 3.2.4 - Komentarze:

Biała spacja nie jest dozwolona między otwierającym delimiterem deklaracji znacznika ("<!") a otwierającym delimiterem komentarza ("--"), ale jest dozwolona między zamykającym delimiterem komentarza ("--") i zamykającym delimiterem deklaracji znacznika (">"). Pospolitym błędem jest umieszczanie łańcucha kresek ("---") wewnątrz komentarza. Twórcy powinni unikać wstawiania wewnątrz komentarza dwóch lub więcej sąsiadujących kresek.

Przykłady

Poniżej przedstawiono prawidłowe komentarze HTML.

<!-- poprawny komentarz HTML -->
<!-- poprawny komentarz HTML -- >

Poniżej przedstawiono nieprawidłowy komentarz HTML.

<!-- niepoprawny -- komentarz HTML -->

XML

Z Rekomendacji W3C dla XML 1.0, Sekcji 2.5 - Komentarze:

Definicja: Komentarze mogą pojawiać się w dokumencie gdziekolwiek poza innymi znacznikami; ponadto mogą pojawiać się wewnątrz deklaracji typu dokumentu w miejscach dozwolonych przez gramatykę. Nie wchodzą w skład danych znakowych dokumentu; procesor XML może, choć nie musi, umożliwić aplikacji wydobywać tekst komentarzy. W celu zapewnienia kompatybilności, łańcuch "--" (podwójna kreska) nie może występować wewnątrz komentarzy. Odwołania do parametrów encji nie mogą być rozpoznawane wewnątrz komentarzy.
[15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

Zgodnie z opisem gramatyki komentarzy w XML, komentarz ma postać

<!-- znaki bez sąsiadujących kresek -->

Przykłady

Poniżej przedstawiono prawidłowy komentarz XML i XHTML.

<!-- poprawny komentarz xml/xhtml -->

Poniżej przedstawiono nieprawidłowe komentarze XML i XHTML.

<!-- nieprawidłowy -- komentarz xml -->
<!-- nieprawidłowy komentarz xml --->
<!-- nieprawidłowy komentarz xml -- >

Lektury uzupełniające

Informacje o dokumencie

  • Ostatnia aktualizacja: 19 maj 2003
  • Copyright © 2001-2003 Netscape. All rights reserved.
  • Tłumaczenie: Krzysztof Jurewicz
{{ languages( { "en": "en/The_Importance_of_Correct_HTML_Commenting", "es": "es/HTML/La_importancia_de_comentar_correctamente", "fr": "fr/De_l\'importance_des_commentaires_bien_form\u00e9s_en_HTML", "ja": "ja/The_Importance_of_Correct_HTML_Commenting", "ko": "ko/The_Importance_of_Correct_HTML_Commenting" } ) }}

Autorzy i etykiety dokumentu

Autorzy tej strony: Ptak82, Nerf, Dria, Mgjbot
Ostatnia aktualizacja: Mgjbot,