← Back to NOTES 🌰 ← Back to Effective TypeScript

← 아이템 47 - 공개 API에 등장하는 모든 타입을 익스포트하기

핵심 요약

export된 함수, 클래스, 타입에 주석을 달 때는 JSDoc/TSDoc 형태를 사용하자. TSDoc을 사용할 때는 타입 정보를 넣지 말자 (타입 정보는 이미 코드에 있기 때문). 마크다운을 적절히 사용하여 가독성을 높이고, 주석은 장황하게 쓰는 것보다 간단히 요점만 쓰도록 하자.

자세한 내용

인라인 주석 vs JSDoc

인라인 주석의 문제점:

• 편집기에서 툴팁으로 표시되지 않음
• API 문서화에 사용할 수 없음

JSDoc의 장점:

• 편집기에서 툴팁으로 표시됨
• 호버 시 함수 설명을 바로 볼 수 있음
• API 문서 자동 생성 가능

JSDoc 태그 활용

@param: 매개변수 설명 @return: 반환값 설명 @example: 사용 예제 @deprecated: 더 이상 사용하지 않는 API 표시

타입 정의에서의 TSDoc

타입 정의(interface, type)에서도 TSDoc을 사용할 수 있다.

마크다운 지원

TSDoc은 마크다운 형식으로 꾸며지므로: