Notice
목록프로그래밍👩🏻💻/Typescript (1)
suyeonme
[Typescript] TSDoc이란?
1. TSDoc이란? TSDoc은 타입스크립트 코드에서 사용되는 doc comments로 , API 문서를 작성하고 코드에 대한 메타 데이터를 정의할 수 있다. 타입스크립트는 정적 타이핑을 제공하기 때문에 TSDoc을 사용하면 코드에 대한 디테일을 수월하게 기술할 수 있다. VScode에서 TSDoc 을 지원하므로 TSDoc의 태그를 사용하여 커멘트를 남기면, 하이라이팅이 되어 손쉽게 커멘트를 식별할 수 있으며 코드에 대한 힌트를 얻을 수 있다는 장점이 있다. 규칙은 아래와 같다. 커멘트는 /**로 시작한다. 태그는 @를 사용한다. (e.g. @returns) 2. 태그(Tag) 종류 태그를 사용하여 커멘트의 사용 용도를 분류할 수 있다. 자주사용할 것 같은 태그를 정리하였다. @deprecated 더이..
프로그래밍👩🏻💻/Typescript
2022. 6. 1. 15:10