19 개발 블로그

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

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

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

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

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

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

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

<!--주석

개행을 하여도

상관없습니다.

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

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

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

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

<!DOCTYPE HTML>

<html>

<head>

</head>

<body>

</body>

</html>

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

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

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

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

티스토리툴바