A importância de comentar o HTML corretamente

  • Slug da revisão: A_importância_de_comentar_o_HTML_corretamente
  • Título da revisão: A importância de comentar o HTML corretamente
  • ID da revisão: 352007
  • Criado:
  • Autor: egon_yuri
  • É revisão atual? Não
  • Comentário

Conteúdo da revisão

Quando escrevemos HTML em modo padrão, comentários formados incorretamente podem quebrar suas páginas, resultando em parte ou todo o seu conteúdo sendo descomentado. Quando escrevendo XHTML ou XML, comentários incorretos resultarão em seus documentos não sendo capaz de ser exibido ao todo.

HTML 4.01

De Recomendação W3C HTML 4.01 - Seção 3.2.4 - Comentários:

Espaço em branco não é permitido entre o delimitador aberto de declaração de marcação ("<!") e o delimitador de comentário aberto ("--"), mas é permitido entre o comentário fechado ("--") e o delimitador fechado de declaração de marcação (">"). Um erro comum é incluir uma string de hífens ("---") dentro de um comentário. Autores devem evitar colocar dois ou mais hífens adjacentes dentro de comentários.

Exemplos

O que vem a seguir são comentários válidos em HTML.

<!-- valid html comment -->
<!-- valid html comment -- >

O que vem a seguir é um comentário não válido em HTML.

<!-- invalid -- html comment -->

XML

De Recomendação W3C XML 1.0 - Seção 2.5 - Comentários:

Definições Comentários podem aparecer em qualquer lugar em um documento fora de outra marcação; em adição, eles podem aparecer dentro da declação de tipo de documento em lugares permitidos pela gramática. Eles não são parte dos caracteres de dados do documento; um processo XML pode, mas não precisa, tornar possível para uma aplicação recuperar o texto dos comentários. Por compatibilidade, o string "--" (hífen duplo) não deve ocorrer dentro dos comentários. As referências da entidade do parâmetro não devem ser reconhecidas dentro dos comentários.
[15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

Como descrito na gramática para comentários em XML, um comentário tem a forma

<!-- characters excluding adjacent dashes -->

Exemplos

O que vem a seguir é um comentário válido em XML e XHTML.

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

O que vem a seguir é um comentário não válido em XML e XHTML.

<!-- invalid -- xml comment -->
<!-- invalid xml comment --->
<!-- invalid xml comment -- >

Leitura adicional

{{ InfoDocOriginal("-", "-", "19/05/03", "Copyright © 2001-2003 Netscape. Todos os direitos reservados.") }}

Categorias

Interwiki Language Links

{{ 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", "pl": "pl/HTML/Znaczenie_poprawnego_komentowania", "ko": "ko/The_Importance_of_Correct_HTML_Commenting" } ) }}

Fonte da revisão

<p>Quando escrevemos HTML em <a class="external" href="http://www.mozilla.org/docs/web-developer/quirks/doctypes.html">modo padrão</a>, comentários formados incorretamente podem quebrar suas páginas, resultando em parte ou todo o seu conteúdo sendo descomentado. Quando escrevendo XHTML ou XML, comentários incorretos resultarão em seus documentos não sendo capaz de ser exibido ao todo.</p>
<h3 id="HTML_4.01" name="HTML_4.01">HTML 4.01</h3>
<p><i>De <a class="external" href="http://www.w3.org/TR/html4/intro/sgmltut.html#h-3.2.4">Recomendação W3C HTML 4.01 - Seção 3.2.4 - Comentários</a>:</i></p>
<p>Espaço em branco não é permitido entre o delimitador aberto de declaração de marcação ("&lt;!") e o delimitador de comentário aberto ("--"), mas é permitido entre o comentário fechado ("--") e o delimitador fechado de declaração de marcação ("&gt;"). Um erro comum é incluir uma <i>string</i> de hífens ("---") dentro de um comentário. Autores devem evitar colocar dois ou mais hífens adjacentes dentro de comentários.</p>
<h4 id="Exemplos" name="Exemplos">Exemplos</h4>
<p>O que vem a seguir são comentários válidos em HTML.</p>
<pre class="eval">
&lt;!-- valid html comment --&gt;
&lt;!-- valid html comment -- &gt;
</pre>
<p>O que vem a seguir é um comentário não válido em HTML.</p>
<pre class="eval">
&lt;!-- invalid -- html comment --&gt;
</pre>
<h3 id="XML" name="XML">XML</h3>
<p><i>De <a class="external" href="http://www.w3.org/TR/REC-xml#sec-comments">Recomendação W3C XML 1.0 - Seção 2.5 - Comentários</a>:</i></p>
<blockquote>
  <b>Definições</b> Comentários podem aparecer em qualquer lugar em um documento fora de outra marcação; em adição, eles podem aparecer dentro da declação de tipo de documento em lugares permitidos pela gramática. Eles não são parte dos caracteres de dados do documento; um processo XML pode, mas não precisa, tornar possível para uma aplicação recuperar o texto dos comentários. Por compatibilidade, o <i>string</i> "--" (hífen duplo) não deve ocorrer dentro dos comentários. As referências da entidade do parâmetro não devem ser reconhecidas dentro dos comentários.
  <pre>
[15] Comment&nbsp;::= '&lt;!--' ((Char - '-') | ('-' (Char - '-')))* '--&gt;'
</pre>
</blockquote>
<p>Como descrito na gramática para comentários em XML, um comentário tem a forma</p>
<pre class="eval">
&lt;!-- characters excluding adjacent dashes --&gt;
</pre>
<h4 id="Exemplos_2" name="Exemplos_2">Exemplos</h4>
<p>O que vem a seguir é um comentário válido em XML e XHTML.</p>
<pre class="eval">
&lt;!-- valid xml/xhtml comment --&gt;
</pre>
<p>O que vem a seguir é um comentário não válido em XML e XHTML.</p>
<pre class="eval">
&lt;!-- invalid -- xml comment --&gt;
&lt;!-- invalid xml comment ---&gt;
&lt;!-- invalid xml comment -- &gt;
</pre>
<h3 id="Leitura_adicional" name="Leitura_adicional">Leitura adicional</h3>
<ul>
  <li><a class="external" href="http://www.w3.org/TR/html4/intro/sgmltut.html#h-3.2.4">Recomendação HTML 4.01: 3.2.4 - Comentários</a></li>
  <li><a class="external" href="http://www.w3.org/TR/REC-xml#sec-comments">Recomendação XML: 2.5 - Comentários</a></li>
  <li><a class="link-https" href="https://bugzilla.mozilla.org/show_bug.cgi?id=144432">Bugzilla bug 144432</a></li>
  <li><a class="link-https" href="https://bugzilla.mozilla.org/show_bug.cgi?id=102127">Bugzilla bug 102127</a></li>
</ul>
<p>{{ InfoDocOriginal("-", "-", "19/05/03", "Copyright © 2001-2003 Netscape. Todos os direitos reservados.") }}</p>
<p><span class="comment">Categorias</span></p>
<p><span class="comment">Interwiki Language Links</span></p>
<p>{{ 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", "pl": "pl/HTML/Znaczenie_poprawnego_komentowania", "ko": "ko/The_Importance_of_Correct_HTML_Commenting" } ) }}</p>
Reverter para esta revisão