주석 작성법을 알아보자!

 

우리가 작성한 코드는 종종 복잡하고 미묘한 퍼즐처럼 얽혀 있어.

이 코드 퍼즐의 답을 찾기 위해서는 주석이 필요해.

주석은 코드의 이야기책처럼, 우리에게 무엇이 어떻게 돌아가고 있는지 알려줘.

주석이 없는 코드는 마치 암호화된 비밀 메시지처럼 보여. 그걸 푸는 것은 상상 이상의 과제가 될 수 있어.

그리고 기억력이 좋지 않은 우리도 코드에 주석을 작성하면 잊어버리는 걱정 없이 코드를 읽을 수 있지.

마치 포스트잇 같은거야.

 

위의 함수를 보면 어떤 기능을 하는지, 뭘 넣고 뭘 뱉는지 모르지 않음?

그래서 일반적으로 주석을 아래 달지.

아무런 설명이 없는 것보단 나을 수 있겠지만,

이렇게 주석을 작성하게 되면?

함수명에 마우스를 갖다대면 이렇게 함수를 설명해주지. 

이러한 기능은 JSDoc 이라는 부가기능이야.

/**을 치게 되면 JSDoc의 기능을 좀 더 활요하게 도와주는데, 이렇게 변수를 설명할 수 있지. 

이렇게 완벽하게 함수에 대해 설명하는 주석을 적절하게 잘 사용해보자.