The Importance of Correct HTML Commenting

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 주석 -- >

더 읽을거리

• HTML 4.01 Recommendation: 3.2.4 - Comments
• XML Recommendation: 2.5 - Comments
• Bugzilla bug 144432
• Bugzilla bug 102127