Typedoc, ts 유틸 함수를 문서화해줘!
1. typedoc의 필요성 프로젝트에서 많은 수의 유틸 함수가 있으면, 각 함수의 용도와 사용법을 파악하기 어려워진다. 특히 프로젝트가 복잡해지고, 많은 사람들이 참여할 때 문제가 커진다. 이러한 문제는 typedoc을 사용해 유틸 함수를 문서화하면 해결할 수 있다! typedoc을 사용하면 함수의 용도와 사용법을 명확하게 알 수 있어, 유지 보수가 쉬워지고 개발자들의 생산성을 높일 수 있다 🙂 그렇다면 이 typedoc은 무엇이며 어떻게 설정해야할까? 한 번 알아보자! 2. typedoc이란? 1) typedoc은 무엇일까? TypeDoc은 TypeScript 코드에서 JSDoc 주석을 추출하여 API 문서로 생성하는 도구이다. TypeDoc을 사용하면 TypeScript 코드의 문서화를 쉽게 할 수..
2023. 4. 23.
