기념비적인 Velog에서의 첫 오리지널 포스트입니다. HTML 카테고리를 옮기다보니 주석과 같은 기초적인 부분에 대해서 설명을 하지 않았더라고요. 그래서 추가하게 되었습니다.
주석 Comment
주석(Comment)는 문서에 설명을 붙이는 것을 말합니다. 문서에 설명을 왜 붙여야할까요? 작성자 본인이 혹은 다른 사람이 문서를 봤을 때 이 부분에서 이것이 어떤 의도로 사용되었고, 이 부분이 무엇을 의미하는지 알기 쉽게 하기 위해서 사용합니다.
저는 주석을 처음 접하는 분들에게는 양날의 단검이라고 생각합니다. 왜냐하면 주석에 너무 자세하고 길게 적으면 오히려 문서가 복잡해지고, 너무 짧거나 없으면 문서를 이해하기 힘드니까요. 물론 주석도 많이 달다보면 짧고 간결하게 작성할 수 있게됩니다. 그런 수준에 도달한다면 주석은 양날의 검이 아닌 최고의 무기가 됩니다.
어쩌다보니 잡설이 길었습니다. 그럼 본격적으로 HTML에서 주석을 다는 방법을 알아보겠습니다.
주석은 <!-- 주석 내용 -->의 형태로 삽입할 수 있습니다. 주석은 문서를 보는 사람을 위한 용도이기 때문에, 주석 내용은 해석되어 브라우저에 나타나지 않습니다.
<!--주석은 한 줄도 좋고-->
<p>일반 태그</p>
<!--
여러줄도 좋다고 하네요.
-->일반 태그와 달리 주석은 회색으로 표시됩니다. 또한 한 줄 이상의 주석을 달 수 있습니다. <!-- -->내부에만 작성된다면요.
이렇게
HTML에서 주석을 다는 방법을 알아보았습니다.