Comparar revisões

A importância de comentar o HTML corretamente

Change Revisions

Revisão 283234:

Revisão 283234 por Luis Henrique Sousa a

Revisão 226508:

Revisão 226508 por Luis Henrique Sousa a

Título:
A importância de comentar o HTML corretamente
A importância de comentar o HTML corretamente
Slug:
A_importância_de_comentar_o_HTML_corretamente
A_importância_de_comentar_o_HTML_corretamente
Etiquetas:
HTML, Todas_as_Categorias
Conteúdo:

Revisão 283234
Revisão 226508
t7    <p>t
8      Quando escrevendo HTML em <a class="external" href="http://
>www.mozilla.org/docs/web-developer/quirks/doctypes.html">modo pad 
>rão</a>, comentários formados incorretamente podem quebrar suas p 
>áginas, resultando em parte ou todo o seu conteúdo sendo descomen 
>tado. Quando escrevendo XHTML ou XML, comentários incorretos resu 
>ltarão em seus documentos não sendo capaz de ser exibido ao todo. 
9    </p>
10    <h3 id="HTML_4.01" name="HTML_4.01">
11      HTML 4.01
12    </h3>
13    <p>
14      <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> 
15    </p>
16    <p>
17      Espaço em branco não é permitido entre o delimitador aberto
> de declaração de marcação ("&lt;!") e o delimitador de comentári 
>o 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 d 
>e um comentário. Autores devem evitar colocar dois ou mais hífens 
> adjacentes dentro de comentários. 
18    </p>
19    <h4 id="Exemplos" name="Exemplos">
20      Exemplos
21    </h4>
22    <p>
23      O que vem a seguir são comentários válidos em HTML.
24    </p>
25    <pre class="eval">
26&lt;!-- valid html comment --&gt;
27&lt;!-- valid html comment -- &gt;
28</pre>
29    <p>
30      O que vem a seguir é um comentário não válido em HTML.
31    </p>
32    <pre class="eval">
33&lt;!-- invalid -- html comment --&gt;
34</pre>
35    <h3 id="XML" name="XML">
36      XML
37    </h3>
38    <p>
39      <i>De <a class="external" href="http://www.w3.org/TR/REC-xm
>l#sec-comments">Recomendação W3C XML 1.0 - Seção 2.5 - Comentário 
>s</a>:</i> 
40    </p>
41    <blockquote>
42      <b>Definições</b> Comentários podem aparecer em qualquer lu
>gar em um documento fora de outra marcação; em adição, eles podem 
> aparecer dentro da declação de tipo de documento em lugares perm 
>itidos 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 co 
>mpatibilidade, o <i>string</i> "--" (hífen duplo) não deve ocorre 
>r dentro dos comentários. As referências da entidade do parâmetro 
> não devem ser reconhecidas dentro dos comentários. 
43      <pre>
44[15] Comment ::= '&lt;!--' ((Char - '-') | ('-' (Char - '-')))* '
>--&gt;' 
45</pre>
46    </blockquote>
47    <p>
48      Como descrito na gramática para comentários em XML, um come
>ntário tem a forma 
49    </p>
50    <pre class="eval">
51&lt;!-- characters excluding adjacent dashes --&gt;
52</pre>
53    <h4 id="Exemplos_2" name="Exemplos_2">
54      Exemplos
55    </h4>
56    <p>
57      O que vem a seguir é um comentário válido em XML e XHTML.
58    </p>
59    <pre class="eval">
60&lt;!-- valid xml/xhtml comment --&gt;
61</pre>
62    <p>
63      O que vem a seguir é um comentário não válido em XML e XHTM
>L. 
64    </p>
65    <pre class="eval">
66&lt;!-- invalid -- xml comment --&gt;
67&lt;!-- invalid xml comment ---&gt;
68&lt;!-- invalid xml comment -- &gt;
69</pre>
70    <h3 id="Leitura_adicional" name="Leitura_adicional">
71      Leitura adicional
72    </h3>
73    <ul>
74      <li>
75        <a class="external" href="http://www.w3.org/TR/html4/intr
>o/sgmltut.html#h-3.2.4">Recomendação HTML 4.01: 3.2.4 - Comentári 
>os</a> 
76      </li>
77      <li>
78        <a class="external" href="http://www.w3.org/TR/REC-xml#se
>c-comments">Recomendação XML: 2.5 - Comentários</a> 
79      </li>
80      <li>
81        <a class="link-https" href="https://bugzilla.mozilla.org/
>show_bug.cgi?id=144432">Bugzilla bug 144432</a> 
82      </li>
83      <li>
84        <a class="link-https" href="https://bugzilla.mozilla.org/
>show_bug.cgi?id=102127">Bugzilla bug 102127</a> 
85      </li>
86    </ul>
87    <p>
88      {{ InfoDocOriginal("-", "-", "19/05/03", "Copyright © 2001-
>2003 Netscape. Todos os direitos reservados.") }} 
89    </p>
90    <p>
91      <span class="comment">Categorias</span>
92    </p>
93    <p>
94      <span class="comment">Interwiki Language Links</span>
95    </p>{{ languages( { "en": "en/The_Importance_of_Correct_HTML_
>Commenting", "es": "es/HTML/La_importancia_de_comentar_correctame 
>nte", "fr": "fr/De_l\'importance_des_commentaires_bien_form\u00e9 
>s_en_HTML", "pl": "pl/HTML/Znaczenie_poprawnego_komentowania", "k 
>o": "ko/The_Importance_of_Correct_HTML_Commenting" } ) }} 

Voltar ao Histórico