[TypeScript] Documenting Functions

와썹 동기 여러분! 오늘은 타입스크립트에서 함수에 코멘트 다는 방법에 대해 알아봅시다!

 

Documenting Functions

자바스크립트에서 코멘트를 다는 방법이 두가지가 있었는데 아래의 코드를 봅시다.

// 한 줄에 코멘트를 다는 경우

/* 
여러 줄에
코멘트를
다는
경우
*/

 

타입스크립트에서는 다른 방법으로 코멘트를 다는 경우도 있습니다. (물론, 위 방법도 여전히 사용가능)

이를 문서형 코멘트(documentation comment)라고 부릅니다.

/**
* 문서형 코멘트
* Documentation comment
*/

 

---

어떤 상황에서 쓰일까

함수(function)에 관해 코멘트를 다는 경우 아주 유용하게 쓸 수 있습니다.

/**
 * Returns the result of multiplied a and b.
 * @param a - The first input number
 * @param b - The second input number
 * @returns The result of multiplied `a` and `b`
 */
function multiply(a: number, b: number):number {
    return a * b;
}

• 아마 VS코드를 사용하신다면 /** 만 쓰고 엔터키를 누르면 자동으로 @param a 와 @param b 까지는 완성시켜줍니다.
• 보통 매개 변수를 나타낼 때는 @param을 사용하고 리턴을 나타낼 때도 @returns를 사용합니다.
• 문서형 코멘트는 보통 설명하고자하는 함수 바로 위에 만듭니다.

 

/**
 * a와 b를 곱한 값을 리턴한다.
 * @param a - 첫 번째 인풋 숫자
 * @param b - 두 번째 인풋 숫자
 * @returns `a`와 `b`를 곱한 결괏값
 */
function multiply(a: number, b: number):number {
    return a * b;
}

• 한글로 쓰니 마음이 편안하군요.

 

---

 

오늘의 느낌

빨리 헬스장 문이 열렸으면 좋겠다.