무언가 개발을 할 때. 잘 짜는 것도 중요하지만 주석 역시 중요하다.


주석을 잘 달아놓아야 나중에 내가 봤을 때. 무엇인지 빠르게 확인이 가능하고,



무엇보다 실제 업무에서는 대부분 팀을 이루어서 작업을 할테고, 굳이 팀이 아니더라도 당신이 나가고나서 다른 사람이 그 프로그램을 이어서 개발해야하는데. 설명도 없다면 정말로 난감하겠죠?




고로 주석을 달아둬야 합니다. 그리고 문서화도 해두어야 하지만, 프로젝트를 하는 것도 아니기에 일단 주석만 알아도 충분합니다.


(사실 저도 문서화 같은거 해본적이 없어요...)






HTML에서 주석은 이거 하납니다.


<!--주석으로 담을 말-->


이런식으로 작성하면 됩니다.



<!--주석

개행을 하여도

상관없습니다.

열고닫는거만 잘해주세요-->




주석처리를 하게 되면 주석 부분은 해석을 하지 않습니다.


그래서 설명을 해둔다던지, 혹은 잘못된 부분을 찾아볼 때. 잠시 소스가 실행 안되도록 해버릴 때. 사용합니다.






실제로 작성하게 되면 주석으로 된 부분은 해석하지 않습니다.


<!DOCTYPE HTML>

<html>

<head>

    <title>주석을 알아보자</title>

    <meta charset="utf-8" />

</head>


<body>

    <p>주석으로 처리하면 해석하지 않습니다.</p>

    <!--<p>이거 죽었다 깨어나도 출력 안됨.</p>-->

</body>

</html>



실제 출력하면 이렇게 보일 것 입니다.


주석으로 처리하면 해석하지 않습니다.



우 클릭 해서 이 페이지의 소스 보기를 하면 아마 주석이 보일 것 입니다.


블로그 내에서 출력하는 것이라 body태그 내부의 태그 두 줄만 적어 놓았지만, 큰 차이는 없습니다.

'프로그래밍 > HTML5' 카테고리의 다른 글

[HTML5] 테이블 태그 (2) - 셀 합치기  (0) 2016.07.26
[HTML5] 테이블 태그 (1) - 기본  (0) 2016.07.22
[HTML5] 주석 달기  (3) 2016.07.20
[HTML5] 목록 태그  (0) 2016.07.20
[HTML5] 글자 모양 태그  (0) 2016.07.18
[HTML5] 하이퍼링크 태그 <a>  (0) 2016.07.15
  1. nito 2016.11.10 10:36

    여쭤 볼 것이 있어서 덧 달아 봅니다.
    제가 소스를
    <!DOCTYPE HTML>
    <html>
    <head>
    <meta charset="UTF-8">
    <style type="text/css">
    #intro_text { position: relative; left: 10%; width: 60%; padding: 5px;
    border: medium double black; border-radius: 10px;
    box-shadow: 8px 8px 20px 2px blue; }
    #w3c_float { float:right; border: thin solid black; padding: 5px;
    border-top-left-radius:8px; border-bottom-right-radius:8px;
    box-shadow: 2px 2px 20px 4px green inset; }
    </style>
    </head>
    <body>
    <h3>5.5 새로운 문서 표준 HTML5</h3>
    <img src="W3C_logo.png" id="w3c_float" width="72" height="40">
    <p id="intro_text">
    현재 W3C에서 표준안 개발을 하고 있는 HTML5는 차세대 웹문서 표준안으로 많은 관심이 집중되고 있다. 특히, 표준안 개발에 마이크로소프트, 모질라, 애플, 구글, 오페라 등 대다수 웹 브라우저 개발사가 참여하고 있고, 그 동안의 웹 기술의 발전을 많이 반영하여 모바일을 포함한 차세대 웹서비스 개발의 주요 기술로 주목받고 있다,
    </p>
    </body>
    </html>
    이렇게 작성 하였는 데


    #w3c_float { float:right; border: thin solid black; padding: 5px;
    border-top-left-radius:8px; border-bottom-right-radius:8px;
    box-shadow: 2px 2px 20px 4px green inset; }

    이 부분을 <!-- --> 이렇게 해도 HTML (크롬)으로 돌렸을 때 주석이 제대로 되지 않는 건지 이미지 부분의 박스가 계속 id로 인식이 되어서 나오는 데 이 부분은 어떻게 풀어가야 할까요?

  2. BlogIcon Lazyig  블로그 2016.11.10 10:37 신고

    해당 부분은 스타일시트 부분이므로 문법이 다릅니다. /* 내용 */ 이렇게 처리해주세요.


    • 2016.11.10 10:39

      비밀댓글입니다

댓글 작성