더북(TheBook)

 

SECTION 1.4 타입스크립트의 현실적인 대안 JSDoc

그렇다면 이 두 가지 단점을 무릅쓰고라도 타입스크립트를 배우는 것이 맞을까요? 큰 비용을 들여서 타입스크립트를 배워 적용하는 것보다 더 현실적인 대안이 있습니다. 바로 JSDoc을 사용하는 방법입니다.

JSDoc은 자바스크립트 코드에 주석을 다는 표준 방식입니다. Java 소스 코드에서 HTML 형식의 API 문서를 생성하고자 썬 마이크로시스템즈(Sun Microsystems)에서 제작한 주석화 도구인 JavaDoc과 유사한 형태이며, 고유한 문법이 있습니다. 한번 볼까요?

/**
 * @description 두 수의 합을 구하는 함수
 * @param {number} a 첫 번째 숫자
 * @param {number} b 두 번째 숫자
 */
function sum(a, b) {
  return a + b;
}
신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.