0030 HTML 주석(comment) 달기
다른 모든 프로그래밍 언어처럼 HTML에도 주석(comment)을 달 수 있다.
주석(comment)은 개발자가 작성한 코드에 부가하여 이런 저런 설명을 지칭하는 것으로 브라우저가 해당 텍스트를 실행하거나 표시하지 않게끔 만들어진 형식으로 작성된 텍스트로 나타난다. 가령, 이 코드를 작성했을 때 어떤 생각으로 작성했는지 본인의 기억을 환기하거나 다른 사람이 코드를 봤을 때 이해하기 쉽도록 주석(comment)을 붙인다.
HTML에서 주석은 다음과 같은 형식으로 작성한다.
<!-- 여기에 이런 저런 주석을 단다. -->
주석은 꼭 1개의 행에 있어야할 필요 없이 여러 행에 걸쳐서 주석으로 처리할 수 있다.
다음과 같이 
0030.html을 작성하고 실행해보자.
<!DOCTYPE html>
<html>
<head><title>주석(comment)</title></head>
<body>
<h3>주석 처리된 문단</h3>
<!--
<p>
이 문단은 주석 처리 되었다. <br />
그래서 보이지 않을 것이다.
</p>
-->
<h3>주석 처리되지 않은 문단</h3>
<p>
이 문단은 주석 처리가 되지 않았다. <br />
그래서 보일 것이다.
</p>
</body>
</html>
실행해보면 아래와 같이 주석 처리된 문단이 전혀 나타나지 않는다.
HTML 문서유형선언(Document type declaration)에서 한 번 설명한 것처럼 왼쪽 꺽쇠(<) 다음에 느낌표(!)가 오면 요소(element)가 아니라는 뜻이다. 오른쪽 꺽쇠(>)에 붙는 것이 아니란 점에 주의하자.
주석은 오직 개발자가 소스코드를 볼 때에만 의미가 있다. 브라우저는 주석 처리된 문장을 표시하지도 않고 내부적으로 어떤 처리도 하지 않으며 완전히 깔끔하게 없는 것으로 무시한다.
브라우저가 주석을 완전히 깔끔하게 무시하기 때문에 디버깅을 할 때 이러한 주석을 활용하면 매우 유용하다. 가령, 에러를 찾기 위해 코드를 하나하나 뒤져볼 때 해당 코드를 지우지 말고 주석 처리하면 임시적으로 그 코드를 분리시킬 수 있어 에러가 어떤 코드에서 시작된 것인지 찾기 쉬워진다.
그 외에도 주석을 잘 달면 가독성이 좋아지고 다른 사람이 해당 코드로 다시 작업을 할 때에도 접근하기 쉬워진다. 게다가 이러한 주석을 이용하여 자동으로 매뉴얼 등의 문서를 바로 만들어주는 프로그램도 있어 주석이 충실하면 문서화를 쉽게 할 수 있다. 이렇듯 주석을 충실하게 달았을 때 이점이 상당하므로 항상 충실하게 주석을 다는 습관을 갖도록 하자.
Anki 파일
아래는 본 포스팅의 내용을 갈무리하기 위한 Anki 파일입니다. 참고하시기 바랍니다.
Ankilog 파일: 
0030 HTML 주석(comment) 달기.apkg
'Anki로 공부하기 > HTML공부' 카테고리의 다른 글
| 0032 CSS 소개 (0) | 2018.12.04 |
|---|---|
| 0031 약어(character entity)로 특수문자 표시하기 (0) | 2018.12.03 |
| 0029 정의 목록(description list) 요소 다루기 (0) | 2018.12.01 |
| 0028 HTML 순서가 있는(ordered) 목록의 글머리 기호 바꾸기 (0) | 2018.11.30 |
| 0027 HTML 순서가 없는(unordered) 목록의 글머리 기호 바꾸기 (0) | 2018.11.29 |