라이브러리

라이브러리

[TypeDoc] TypeDoc으로 TypeScript 프로젝트 문서화 하기

Intro 프로젝트를 진행하면서 jsdoc을 활용해서 코드 주석을 작성하고 있었다. 문서화를 위해 문서 생성을 시도했지만 타입스크립트 변환이 일부 실패하면서 타입스크립트 문서화에 적합한 라이브러리를 찾아보던 중 TSDoc 와 TypeDoc 라이브러리를 알게 되었다.  TSDoc공식 사이트 : https://tsdoc.org/NPM : https://www.npmjs.com/package/@microsoft/tsdoc깃허브 : https://github.com/microsoft/tsdoc  조사해보니 TSDoc은 Microsoft가 제안하고 주도하는 오픈 소스 표준으로, TypeScript 코드의 주석을 문서화하기 위한 스타일 가이드를 제공한다고 한다. 나는 타입스크립트 기반의 주석을 잘 문서화시킬 수 있..

캐럿노트
'라이브러리' 카테고리의 글 목록