La importancia de comentar correctamente

Cuando escribimos HTML en modo estándar, los comentarios mal formados pueden romper las páginas, causando que los contenidos del documento sean parcial o totalmente comentados. Al escribir XHTML o XML, los comentarios incorrectos darán lugar a que sus documentos no puedan ser mostrados.

HTML 4.01

De la Recomendación del W3C HTML 4.01 Sección 3.2.4 - Comentarios:

No se permite espacio en blanco entre el delimitador de apertura de declaración de etiqueta ("<!") y el delimitador de apertura de comentario ("--"), pero sí se permite entre el delimitador de cierre de comentario ("--" y el delimitador de cierre de declaración de etiqueta (">"). Un error común es incluir una cadena de guiones ("---") dentro de un comentario. Los autores deberían evitar *poner dos o más guiones adyacentes dentro de un comentario.

Ejemplos

Los siguientes son comentarios válidos en HTML.

<!-- comentario html válido -->
<!-- comentario html válido -- > 

El siguiente no es un comentario válido en HTML.

<!-- comentario html -- no válido -->

XML

De la Recomendación del W3C XML 1.0 Sección 2.5 - Comentarios:

[Definición: Los comentarios pueden aparecer en cualquier lugar de un documento fuera de otras marcas; Adicionalmente pueden aparecer en lugares permitidos por la gramática. No son parte de los datos de caracter de un documento; un procesador de XML puede, pero no tiene que, hacer posible que la aplicación recupere el texto de comentarios.] Por compatibilidad, la cadena "--" (doble guión) no debe ocurrir dentro de comentarios.

[15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

Según lo descrito en la gramática de XML sobre comentarios, un comentario tiene la siguiente forma:

<!-- cualquier letra o signo, menos guiones seguidos -->

Ejemplos

El siguiente es un comentario válido en XML y XHTML.

<!-- comentario xml/xhtml válido -->

Los siguientes son comentarios no válidos en XML y XHTML.

<!-- comentario xml -- no válido -->
<!-- comentario xml no válido --->
<!-- comentario xml no válido -- >

Otras lecturas

• Recomendación HTML 4.01: 3.2.4 - Comentarios
• Recomendación XML: 2.5 - Comentarios
• Bugzilla bug 144432
• Bugzilla bug 102127