[JSInfo] 코드 품질 향상을 위한 주석

주석

// : 한 줄 짜리 주석은 // 사용합니다.

// 이런식으로 주석을 사용하면 됩니다.

/* / : 여러 줄의 주석은 / */ 이렇게 시작합니다.

/* 여
러
줄
*/

설명이 담긴 주석을 많이 사용하면 안됩니다. 주석 없이 코드를 읽을 수 있는 레벨까지 가야합니다.
코드가 불분명해 주석 작성이 불가피하다면 코드를 다시 작성하는 것이 좋습니다.

함수는 주석이 없어도 그 존재 자체가 무슨 역할을 하는지 설명할 수 있어야 합니다.
코드를 분리해 작성하면 더 나은 코드를 만들 수 있습니다. (계속해서 리팩토링을 하는 이유..)

좋은 주석이란?

고차원 컴포넌트의 개요, 컴포넌트 간 상호작용에 대한 설명, 상황에 따른 제어 흐름 등의 조감도

실력 향상 후 이전 코드를 개선하려는 시도를 할 때 주석을 통해 기록을 남겨놓는 것이 좋습니다.
(일종의 안내판 역할)

결과적으로 주석을 사용하는 이유는 시간이 지난 후 유지보수를 위해 작성하는 것입니다.
(코드 작동 원리, 왜?, 무엇을 하는지 등에 대한 구체적인 설명은 주석으로 작성할 필요가 없습니다.)