문서화개발+1
JSDoc 200% 써먹기
JSDoc은 JavaScript API 문서화 도구로, 코드 가독성을 높이는 데 도움이 됩니다. 요즘 백엔드 진영에서는 Swagger가 선호되지만 프론트엔드 진영에서 유용한 JSDoc 기능이 여전히 많습니다. 타입 힌트, 타입 정의와 가져오기, 함수 정보 제시, 정보 연결과 구분이 그 예입니다. 이 글은 프론트엔드 진영에서 사용하기에 좋은 JSDoc 기능과 효과적인 활용 방법을 다뤘습니다.
JSDoc은 JavaScript API 문서화 도구로, 코드 가독성을 높이는 데 도움이 됩니다. 요즘 백엔드 진영에서는 Swagger가 선호되지만 프론트엔드 진영에서 유용한 JSDoc 기능이 여전히 많습니다. 타입 힌트, 타입 정의와 가져오기, 함수 정보 제시, 정보 연결과 구분이 그 예입니다. 이 글은 프론트엔드 진영에서 사용하기에 좋은 JSDoc 기능과 효과적인 활용 방법을 다뤘습니다.
좋은 코드 주석을 작성하려면 주석을 간결하게 작성하고, TODOs/FIXMEs 주석을 활용하는 게 좋습니다. 코드에 문제가 있으면 주석으로 이를 변명하기보다 코드 자체를 새로 쓰는 걸 권장합니다. 또 AI를 사용해 코드 주석을 효율적으로 쓰는 것도 추천합니다.
