프론트엔드
JSDoc 200% 써먹기 \:\ JavaScript API 문서화 기수
두줄요약
JSDoc으로 JavaScript 코드의 타입 힌트와 함수 설명을 풍부하게 남기는 방법을 다뤘습니다.프론트엔드에서 협업과 유지보수를 돕는 태그 활용법과 주의점도 정리했습니다.
핵심 내용
- JSDoc을 JavaScript 코드 문서화와 가독성 향상, 협업 이해 보조 도구로 소개
- 프론트엔드 환경에서 타입 힌트, @typedef 타입 재사용, @returns/@example/@link/@see 등 태그 활용 사례 정리
- @deprecated, @todo, @version 같은 태그로 유지보수 정보와 변경 이력 전달 가능
주의할 점
- JSDoc 타입은 컴파일 시점 타입 강제화가 어려워 코드 리뷰와 테스트 보완 필요
- @typedef 타입은 한 곳에서 중앙 관리해 중복 정의와 의도치 않은 덮어쓰기 방지 필요
- 프레임워크와 TypeScript 지원 범위에 따라 태그 사용 가능 여부 확인 필요
적용해볼 점
- 반복 사용하는 함수와 훅에 설명, 입력값, 반환값, 사용 예시를 함께 작성
- 외부 문서나 디자인 리소스는 @link와 @see로 연결해 맥락 보강
- 제거 예정 요소와 후속 작업은 @deprecated, @todo로 표시해 관리