아이템 48 API 주석에 TSDoc 사용하기

요약

• 익스포트된 함수, 클래스, 타입에 주석을 달 때는 JSDoc/TSDoc 형태를 사용하자. JSDoc/TSDoc 형태의 주석을 달면 편집기가 주석 정보를 표시한다.
• @param, @returns 구문과 문서 서식을 위해 마크다운을 사용할 수 있다.
• 주석에 타입 정보를 포함하면 안 된다.