Revision 197274 of The Importance of Correct HTML Commenting

  • 리비전 슬러그: The_Importance_of_Correct_HTML_Commenting
  • 리비전 제목: The Importance of Correct HTML Commenting
  • 리비전 아이디: 197274
  • 제작일시:
  • 만든이: Aeuiop
  • 현재 리비전인가요? 아니오
  • 댓글 최초 번역
태그: 

리비전 내용

Standards mode에서 HTML 문서를 작성할 경우, 잘못된 주석으로 인해 페이지의 일부 또는 전부가 주석 처리될 수 있습니다. XHTML 또는 XML 문서에 잘못된 주석이 포함되어 있다면 해당 문서를 화면에 표시할 수 없습니다.

HTML 4.01

W3C HTML 4.01 Recommendation Section 3.2.4 - Comments에서 발췌:

공백 문자(white space)는 마크업 선언을 시작하는 구분자("<!")와 주석을 시작하는 구분자("--") 사이에 올 수 없습니다. 하지만 주석을 닫는 구분자("--")와 마크업 선언을 닫는 구분자(">") 사이에는 공백 문자가 올 수 있습니다. 흔히 저지를 수 있는 오류는 주석 안에 연속된 하이픈("---")을 포함하는 것입니다. 문서 작성자는 주석 안에 둘 이상의 연속하는 하이픈을 넣어선 안 됩니다.

다음은 올바른 HTML 주석입니다.

<!-- 올바른 html 주석 -->
<!-- 올바른 html 주석 -- >

다음은 올바르지 않은 HTML 주석입니다.

<!-- 올바르지 않은 -- html 주석 -->

XML

W3C XML 1.0 Recommendation Section 2.5 - Comments에서 발췌:

정의: 주석은 문서의 어디서든 나타날 수 있습니다. 덧붙여 주석은 문법에 의해 허용되는 부분이라면 문서 타입 선언부에도 나타날 수 있습니다. 주석은 문서의 문자 데이터는 아닙니다. 하지만 응용 프로그램이 주석의 내용을 추출하고자 한다면 XML 처리기를 통해 이를 처리할 수 있습니다. 호환성을 위해 연속된 하이픈 "--"이 주석 중간에 나와서는 안됩니다. 주석 안에 있는 파라미터 엔터티 참조를 인식해서는 안 됩니다.
[15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

XML 주석 문법에 설명되어 있듯이 주석은 아래와 같은 형식을 갖습니다.

<!-- 연속하는 대쉬를 제외한 문자들 -->

다음은 올바른 XML, XHTML 주석입니다.

<!-- 올바른 xml/xhtml 주석 -->

다음은 올바르지 않은 XML, XHTML 주석입니다..

<!-- 올바르지 않은 -- xml 주석 -->
<!-- 올바르지 않은 xml 주석 --->
<!-- 올바르지 않은 xml 주석 -- >

더 읽을거리

문서 정보

  • 영문 문서 마지막 갱신일: 2003년 5월 19일
  • 한글 문서 마지막 갱신일: 2006년 9월 25일
  • Copyright © 2001-2003 Netscape. All rights reserved.
{{ wiki.languages( { "en": "en/The_Importance_of_Correct_HTML_Commenting", "es": "es/HTML/La_importancia_de_comentar_correctamente", "pl": "pl/HTML/Znaczenie_poprawnego_komentowania" } ) }}

리비전 소스

<p><a class="external" href="http://www.mozilla.org/docs/web-developer/quirks/doctypes.html">Standards mode</a>에서 HTML 문서를 작성할 경우, 잘못된 주석으로 인해 페이지의 일부 또는 전부가 주석 처리될 수 있습니다. XHTML 또는 XML 문서에 잘못된 주석이 포함되어 있다면 해당 문서를 화면에 표시할 수 없습니다.
</p>
<h3 name="HTML_4.01"> HTML 4.01 </h3>
<p><i><a class="external" href="http://www.w3.org/TR/html4/intro/sgmltut.html#h-3.2.4">W3C HTML 4.01 Recommendation Section 3.2.4 - Comments</a>에서 발췌:</i>
</p><p>공백 문자(white space)는 마크업 선언을 시작하는 구분자("&lt;!")와 주석을 시작하는 구분자("--") 사이에 올 수 없습니다. 하지만 주석을 닫는 구분자("--")와 마크업 선언을 닫는 구분자("&gt;") 사이에는 공백 문자가 올 수 있습니다. 흔히 저지를 수 있는 오류는 주석 안에 연속된 하이픈("---")을 포함하는 것입니다. 문서 작성자는 주석 안에 둘 이상의 연속하는 하이픈을 넣어선 안 됩니다.
</p>
<h4 name=".EC.98.88"> 예 </h4>
<p>다음은 올바른 HTML 주석입니다.
</p>
<pre class="eval">&lt;!-- 올바른 html 주석 --&gt;
&lt;!-- 올바른 html 주석 -- &gt;
</pre>
<p>다음은 올바르지 않은 HTML 주석입니다.
</p>
<pre class="eval">&lt;!-- 올바르지 않은 -- html 주석 --&gt;
</pre>
<h3 name="XML"> XML </h3>
<p><i><a class="external" href="http://www.w3.org/TR/REC-xml#sec-comments">W3C XML 1.0 Recommendation Section 2.5 - Comments</a>에서 발췌:</i>
</p>
<blockquote>
<b>정의:</b> 주석은 문서의 어디서든 나타날 수 있습니다. 덧붙여 주석은 문법에 의해 허용되는 부분이라면 문서 타입 선언부에도 나타날 수 있습니다. 주석은 문서의 문자 데이터는 아닙니다. 하지만 응용 프로그램이 주석의 내용을 추출하고자 한다면 XML 처리기를 통해 이를 처리할 수 있습니다. 호환성을 위해 연속된 하이픈 "--"이 주석 중간에 나와서는 안됩니다. 주석 안에 있는 파라미터 엔터티 참조를 인식해서는 안 됩니다.

<pre>[15] Comment ::= '&lt;!--' ((Char - '-') | ('-' (Char - '-')))* '--&gt;'
</pre></blockquote>
<p>XML 주석 문법에 설명되어 있듯이 주석은 아래와 같은 형식을 갖습니다.
</p>
<pre class="eval">&lt;!-- 연속하는 대쉬를 제외한 문자들 --&gt;
</pre>
<h4 name=".EC.98.88_2"> 예 </h4>
<p>다음은 올바른 XML, XHTML 주석입니다.
</p>
<pre class="eval">&lt;!-- 올바른 xml/xhtml 주석 --&gt;
</pre>
<p>다음은 올바르지 않은 XML, XHTML 주석입니다..
</p>
<pre class="eval">&lt;!-- 올바르지 않은 -- xml 주석 --&gt;
&lt;!-- 올바르지 않은 xml 주석 ---&gt;
&lt;!-- 올바르지 않은 xml 주석 -- &gt;
</pre>
<h3 name=".EB.8D.94_.EC.9D.BD.EC.9D.84.EA.B1.B0.EB.A6.AC"> 더 읽을거리 </h3>
<ul><li> <a class="external" href="http://www.w3.org/TR/html4/intro/sgmltut.html#h-3.2.4">HTML 4.01 Recommendation: 3.2.4 - Comments</a>
</li><li> <a class="external" href="http://www.w3.org/TR/REC-xml#sec-comments">XML Recommendation: 2.5 - Comments</a>
</li><li> {{wiki.template('Named-bug', [ 144432, "Bugzilla bug 144432" ])}}
</li><li> {{wiki.template('Named-bug', [ 102127, "Bugzilla bug 102127" ])}}
</li></ul>
<div class="originaldocinfo">
<h3 name=".EB.AC.B8.EC.84.9C_.EC.A0.95.EB.B3.B4"> 문서 정보 </h3>
<ul><li> 영문 문서 마지막 갱신일: 2003년 5월 19일
</li><li> 한글 문서 마지막 갱신일: 2006년 9월 25일
</li><li> Copyright © 2001-2003 Netscape. All rights reserved.
</li></ul>
</div>
{{ wiki.languages( { "en": "en/The_Importance_of_Correct_HTML_Commenting", "es": "es/HTML/La_importancia_de_comentar_correctamente", "pl": "pl/HTML/Znaczenie_poprawnego_komentowania" } ) }}
현재 리비전 복원