본문으로 건너뛰기

하이라이트

‘JSDoc’ 200% 써먹기

JSDoc은 JavaScript API 문서화 도구로, 코드 가독성을 높이는 데 도움이 됩니다. 요즘 백엔드 진영에서는 Swagger가 선호되지만 프론트엔드 진영에서 유용한 JSDoc 기능이 여전히 많습니다. 타입 힌트, 타입 정의와 가져오기, 함수 정보 제시, 정보 연결과 구분이 그 예입니다. 이 글은 프론트엔드 진영에서 사용하기에 좋은 JSDoc 기능과 효과적인 활용 방법을 다뤘습니다.

자세히 보기

"코드 주석" 태그와 연관된 2개의 게시물이 있습니다.

모든 태그 보기
‘JSDoc’ 200% 써먹기 : JavaScript API 문서화 기수‘JSDoc’ 200% 써먹기 : JavaScript API 문서화 기수

JSDoc은 JavaScript API 문서화 도구입니다. 이 도구는 개발자가 코드 가독성을 높이고, 협업 시 다른 개발자가 코드 의도를 쉽게 이해하는 데 도움이 되는 문서화 기능을 제공하죠.

Fabbro
Fabbro | Software Engineer
좋은 코드 주석은 어떻게 쓰는 걸까?좋은 코드 주석은 어떻게 쓰는 걸까?

이번 포스팅에서는 코드 주석의 중요성과 코드 주석을 잘 쓰는 방법을 알아봅니다. 코드에 남기는 주석은 개발자에게 가장 기본적인 콘텐츠 유형입니다. 이는 ‘자신이 작성한 코드가 하는 일’을 설명하는 걸 넘어서 설계 결정 사항과 트레이드 오프 등 고민 사항을 문서화합니다. 이로써 ‘코드 작성자가 무슨 일을 했고, 왜 그렇게 했는지’ 설명해 줍니다.

Kane
Kane | DevOps Engineer