/** * x를 n번 곱한 수를 반환함 * * @param {number} x 거듭제곱할 숫자 * @param {number} n 곱할 횟수, 반드시 자연수여야 함 * @return {number} x의 n 거듭제곱을 반환함 */ function pow(x, n) { ... }
이렇게 주석을 달면 코드를 읽어보지 않고도 함수의 목적과 사용법을 한눈에 알 수 있습니다.
JSDoc 3이나 기타 유사한 툴을 사용하면 주석으로 HTML 문서를 만들 수 있습니다.자세한 정보는 http://usejsdoc.org/에서 확인하시기 바랍니다.
주석에 들어가면 좋은 내용
- 고차원 수준 아키텍처
- 함수 용례
- 당장 봐선 명확해 보이지 않는 해결 방법에 대한 설명
주석에 들어가면 좋지 않은 내용
- '코드가 어떻게 동작하는지’와 '코드가 무엇을 하는지’에 대한 설명
- 코드를 간결하게 짤 수 없는 상황이나 코드 자체만으로도 어떤 일을 하는지 충분히 판단할 수 없는 경우에만 주석을 넣으세요.