[JavaScript-02] 주석(comment)의 모든 것

주석이란, 프로그래밍 결과에는 반영되지 않는 내용물로서, 

주로 개발자들이 코드를 설명하거나, 

추가로 작업하거나 수정해야 할 부분, 

본인이 작업한 현황 등등을 적어놓는 용도로 사용해요. 

 

먼저, 자바스크립트에서 주석 다는 방법을 알려드릴게요.

 

(1) 한 줄 주석

슬래시 두 개를 써주시면 됩니다

//이것은 주석입니다
console.log('hi')

 

이렇게, 프로그래밍 결과엔 아무런 영향을 주지 않으니, 우리말로 하고싶은 말을 아무거나 적을 수 있는거죠!

 

(2) 두 줄 이상의 주석

그런데, 주석이 한 줄보다 더 길어질 수도 있겠죠?

그럴 땐, /* 주석내용 */ 의 형태로 작성을 해주셔야지, 그렇지 않으면 에러가 납니다!

/*
여러줄
주석을
달고
있어요
*/
console.log('hi')

이런 식으로요!

 

(3) 단축키로 주석 한 번에 처리하기

 

그런데 사실, 개발을 하다 보면, 단축키를 사용해서 주석을 처리하는 버릇(?)이 생기게 된답니다 ㅋㅋ

우선 그냥 주석으로 쓰고싶은 내용들을 쭈욱 써주고,

그 내용들을 드래그해서

 

command키랑 /키를 같이 눌러주세요(윈도우면 커맨드 대신 컨트롤키)

그럼 한 번에 주석 처리가 된답니다!

취소하고 싶으시면 드래그하고 한 번 더 눌러주시거나, 

드래그도 귀찮으면 command랑 z키! (윈도우면 커맨드 대신 컨트롤)

 

(4) 좋은 주석 달기

 

개발을 하다 보면, 다른 사람들과 협업하게 되는 경우가 정말 많아요.

필자도 그렇고, 대부분의 사람들이 코딩을 처음 배우면, 

주석은 대체 뭐하러 배우는거야? 왜 존재하는거야? 생각하는 경우가 많아요.

 

그런데, 사실 주석은 개발 공부를 오래 해야 중요성을 느낄 수 있어요.

주석은, 다른 사람들에게 내 코드를 설명해줄 수 있는 소통 도구입니다.

 

내가 어떤 의미로 이런 코드를 썼는지,

이 변수는 뭘 담고 있는지,

이 부분은 어떤 기능을 수행하는지 등등을, 

 

다른 사람들도 한 번에 이해할 수 있게 쓰는 것이 정말 중요하죠.

 

(5) 주석과 보안

 

제가 재밌는 얘기 하나 해드릴까요?

주석에 작성한 내용은, 프로그래밍 결과에 반영되지만 않는 것이지,

배포하는 순간,

웹을 열어보는 모든 사람들이 볼 수 있어요.

 

그 어떤 웹이든, 크롬 브라우저의 개발자도구를 이용하면,

웹페이지를 구성하고 있는 코드들을 모두 볼 수 있는데요,

거기서 주석도 함께 보여요.

 

그런데, 이 사실을 모르는 개발자들이 간혹 있더라구요.

이제 진짜 재밌는 얘기 해드릴게요.

 

제가 작은 학원에서 알바를 하는데요,

자체 사이트가 있어요. 

아마도 외주를 맡긴 것 같아요. 

그런데, 호기심에 개발자도구를 열어봤는데,

세상에.. 주석으로 어떻게 하면 에러가 발생하는지 적어두셨더라구요....

 

물론 ajax loading과 관련된 것으로, 그리 중대한 에러는 아니지만,

아무리 작은 에러라도 이걸 모두가 보는 공간에 적어두면 좋을 건 없겠죠?

 

우린 앞으로, 주석에 민감한 내용이나 보안과 관련된 내용은 적지 않기로 약속!