[TypeScript] 타입스크립트에서 TSDoc 사용하기

 

대부분의 편집기는 인라인(//)이 아닌 JSDoc(/** */) 스타일의 주석을 툴팁으로 표시해준다.

 

/**
 * 인사말을 생성하는 함수
 * @param name 인사할 사람의 이름
 * @return 인사말
 */
const greetFullTSDoc = (name: string) => {
  return `안녕하세요, ${name}님.`
}

 

이렇게 파라미터의 정보와 리턴 등, 해당 함수에 대한 정보를 보여준다.

 

 

 

 

인터페이스에도 적용해 볼 수 있다.

/** 유저정보 */
interface User {
  /** 유저의 이름 */
  name: string
  /** 유저의 나이 */
  age: number
}

const user1: User = {
  name: 'vinch',
  age: 10000,
}

 

인터페이스를 선언하고 속성에 마우스를 올리면 설명을 확인할 수 있다.

 

 

 

---

 

 

 

 

마크다운도 사용할 수 있다.

 

📄 예시 1.

/**
 * this _interface_ has **three** properties
 */
interface User {
  /** 유저의 이름 */
  name: string
  /** 유저의 나이 */
  age: number
}

const user1: User = {
  name: 'vinch',
  age: 10000,
}

 

 

 

 

📄 예시 2.

/**
 * **에러코드**
 *
 * _400_: 에러코드1
 *
 * _401_: 에러코드2
 *
 * _402_: 에러코드3
 *
 * _403_: 에러코드4
 * */
 export enum ErrorStatus {
	// ...
 }

 

 

 

 

---

 

 

 

출처

댄 밴터캄, 이펙티브 타입스크립트 (프로그래밍 인사이트, 2021)

 

 

 

---

개인적으로 공부한 내용을 정리하는 블로그로
잘못된 개념을 게시하지않도록 주의하고 있으나 오류가 있을 수 있습니다.