La importancia de comentar correctamente

  • Enlace amigable (slug) de la revisión: HTML/La_importancia_de_comentar_correctamente
  • Título de la revisión: La importancia de comentar correctamente
  • Id de la revisión: 166393
  • Creada:
  • Creador: Jorolo
  • ¿Es la revisión actual? No
  • Comentario

Contenido de la revisión

(es una traducción de {{mediawiki.interwiki('en', 'HTML:The_Importance_of_Correct_Commenting', 'The Importance of Correct Commenting')}})

Cuando escribimos HTML en modo estándar, los comentarios incorrectamente formados pueden romper las páginas, causando que parte o todo el contenido sea comentado. Al escribir XHTML o XML, los comentarios incorrectos darán lugar a que sus documentos no puedan ser mostrados totalmente.

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 valido -->
<!-- comentario html valido -- >

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

<!-- comentario html -- no valido -->

XML

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

{{mediawiki.external('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 para comentarios en XML, un comentario tiene la siguiente forma:

<!-- characters excluding adjacent dashes -->

Ejemplos

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

<!-- valid xml/xhtml comment -->

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

Original Document Information

  • Last Updated Date: May 19th, 2003
  • Copyright © 2001-2003 Netscape. All rights reserved.

Categorías

Fuente de la revisión

<p><small>(es una traducción de {{mediawiki.interwiki('en', 'HTML:The_Importance_of_Correct_Commenting', 'The Importance of Correct Commenting')}})</small> <br>
</p><p>Cuando escribimos HTML en <a class="external" href="http://www.mozilla.org/docs/web-developer/quirks/doctypes.html">modo estándar</a>, los comentarios incorrectamente formados pueden romper las páginas, causando que parte o todo el contenido sea comentado.  Al escribir XHTML o XML, los comentarios incorrectos darán lugar a que sus documentos  no puedan ser mostrados totalmente.
</p>
<h3 name="HTML_4.01"> HTML 4.01 </h3>
<p><i>De la <a class="external" href="http://html.conclase.net/w3c/html401-es/intro/sgmltut.html#h-3.2.4">Recomendación del W3C HTML 4.01 Sección 3.2.4 - Comentarios</a>:</i>
</p>
<blockquote>
No se permite espacio en blanco entre el delimitador de apertura de declaración de etiqueta ("&lt;!") 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 ("&gt;"). 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.
</blockquote>
<h4 name="Ejemplos"> Ejemplos </h4>
<p>Los siguientes son comentarios válidos en HTML.
</p>
<pre class="eval">&lt;!-- comentario html valido --&gt;
&lt;!-- comentario html valido -- &gt;
</pre>
<p>El siguiente no es un comentario válido en HTML.
</p>
<pre class="eval">&lt;!-- comentario html -- no valido --&gt;
</pre>
<h3 name="XML"> XML </h3>
<p><i>De la <a class="external" href="http://www.sidar.org/recur/desdi/traduc/es/xml/xml1/index.html#sec-comments">Recomendación del W3C XML 1.0 Sección 2.5 - Comentarios</a>:</i>
</p>
<blockquote>
{{mediawiki.external('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.

<pre>[15] Comment ::= '&lt;!--' ((Char - '-') | ('-' (Char - '-')))* '--&gt;'
</pre>
</blockquote>
<p>Según lo descrito en la gramática para comentarios en XML, un comentario tiene la siguiente forma:
</p>
<pre class="eval">&lt;!-- characters excluding adjacent dashes --&gt;
</pre>
<h4 name="Ejemplos_2"> Ejemplos </h4>
<p>El siguiente es un comentario válido en XML y XHTML.
</p>
<pre class="eval">&lt;!-- valid xml/xhtml comment --&gt;
</pre>
<p>Los siguientes son comentarios no válidos en XML y XHTML.
</p>
<pre class="eval">&lt;!-- comentario xml -- no válido --&gt;
&lt;!-- comentario xml no válido ---&gt;
&lt;!-- comentario xml no válido -- &gt;
</pre>
<h3 name="Otras_lecturas"> Otras lecturas </h3>
<ul><li> <a class="external" href="http://html.conclase.net/w3c/html401-es/intro/sgmltut.html#h-3.2.4">Recomendación HTML 4.01: 3.2.4 - Comentarios</a>
</li><li> <a class="external" href="http://www.sidar.org/recur/desdi/traduc/es/xml/xml1/index.html#sec-comments">Recomendación XML: 2.5 - Comentarios</a>
</li><li> <a class="external" href="http://bugzilla.mozilla.org/show_bug.cgi?id=144432">Bugzilla bug 144432</a>
</li><li> <a class="external" href="http://bugzilla.mozilla.org/show_bug.cgi?id=102127">Bugzilla bug 102127</a>
</li></ul>
<div class="originaldocinfo">
<h3 name="Original_Document_Information"> Original Document Information </h3>
<ul><li> Last Updated Date: May 19th, 2003
</li><li> Copyright © 2001-2003 Netscape. All rights reserved.
</li></ul>
</div>
<p><span class="comment">Categorías</span>
</p>
Revertir a esta revisión