PDF 다운로드 PDF 다운로드

코드에 주석을 달면 자신이나 같이 코드를 짜는 사람들이 나중에 기억할 수 있고, 참고할 수 있다. 또한, 테스트하거나 아직 출시되지 않은 새로운 기능을 시험해 볼 때, 빠르게 구분할 수도 있다. 적절하게 주석을 다는 방법을 배우면 자신과 동료들이 더 효과적으로 코딩을 할 수 있다.

  1. 주석은 태그 <!-- --> 로 표시한다. 무슨 코드인지 간단하게 주석을 달 수 있다.
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    Comment test </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     <!-- 이 코드는 문단임 --> 
     < 
     p 
     > 
    This is the website </ 
     p 
     > 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
    • 주석 태그 사이에 공백이 없어야 한다. 예를 들어, < !-- 는 주석 기능을 하지 못한다. 태그 안에는 원하는 만큼 공백을 둬도 된다.
  2. 주석을 여러 줄 써서 복잡한 코드를 설명하는 데 쓰거나, 긴 코드를 나눌 수 있다.
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    Comment test </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     <!-- 
     주석은 길어도 상관 없다. 
     주석 태그 안에 있으면 
     코드에는 영향이 없다. 
     --> 
     < 
     p 
     > 
    This is the website </ 
     p 
     > 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
  3. 버그를 찾는 중이거나, 코드가 작동하지 않게 하려면 주석기능으로 코드를 막을 수 있다. 이런 식으로 하면, 주석 태그를 지워서 쉽게 코드를 복원할 수 있다.
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    Comment test </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     < 
     p 
     > 
    Check out these images </ 
     p 
     > 
     < 
     img 
     src 
     = 
     "/images/image1.jpg" 
     > 
     <!-- 이미지 잠깐 없애기 
     <img src="/images/image2.jpg"> 
     --> 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
  4. 자바스크립트나 VB스크립트에서 프로그래밍을 한다면, 주석 기능으로 지원하지 않는 브라우저의 주석 기능을 숨길 수 있다. 스크립트 시작에 주석을 달고 //--> 로 끝내면 지원하는 브라우저에만 스크립트가 작동한다.
     < 
     html 
     > 
     < 
     head 
     > 
     < 
     title 
     > 
    VBScript </ 
     title 
     > 
     </ 
     head 
     > 
     < 
     body 
     > 
     < 
     script 
     language 
     = 
     "vbscript" 
     type 
     = 
     "text/vbscript" 
     > 
     <!-- 
     document 
     . 
     write 
     ( 
     "Hello World!" 
     ) 
     //--> 
     </ 
     script 
     > 
     </ 
     body 
     > 
     </ 
     html 
     > 
    
    • 스크립트가 지원되는 브라우저라면, 마지막에 있는 태그 // 가 스크립트가 주석기능을 실행하지 못하게 한다. [1]
    광고

  • 주석기능을 많이 사용하면 나중에 다시 코드를 짤 때 기억하기 쉽다.
  • HTML 코드는 금방 정신없어지기 때문에 주석기능을 사용하여 코드를 정리해야 한다. 코드의 시작과 끝에 주석을 달면 쉽게 찾을 수 있다.
  • PHP도 쓰는 경우가 있다면, PHP에서 어떻게 주석을 다는지도 배워보자.
광고

이 위키하우에 대하여

이 문서는 8,290 번 조회 되었습니다.

이 글이 도움이 되었나요?

광고