이펙티브 타입스크립트 (댄 밴더캄 지음) 를 읽고 정리 📍요약 ✅JSDoc / TSDoc 형태의 주석을 작성하면 에디터에서 주석 정보를 제공해준다 ✅@params, @returns 구문과 문서 서식을 위해 마크다운을 사용할 수 있다 ✅주석에 타입 정보를 포함하면 안된다 => 코드를 봐야할지, 주석을 봐야할지 혼란 초래 📍JSDoc / TSDoc 의 장점 ✅대부분의 에디터에서 함수에 붙은 JSDoc 스타일의 주석을 툴팁으로 표시해 준다 - 함수 설명을 툴팁으로 표시 /** Generate a greeting. Result is formatted for display. */ function greetJSDoc(name: string, title: string) { return `Hello ${title} $..

참고링크 https://jsdoc.app/ Use JSDoc: Index Index Getting Started Getting Started with JSDoc 3 A quick-start to documenting JavaScript with JSDoc. Using namepaths with JSDoc 3 A guide to using namepaths with JSDoc 3. Command-line arguments to JSDoc About command-line arguments to JSDoc. Configuring jsdoc.app Using namepaths with JSDoc 3 JSDoc 3 에서의 Namepaths - 문서의 다른곳에 있는 JavaScript 변수를 참조할 때 해당 변수..

참고 링크 https://jsdoc.app/ Use JSDoc: Index Index Getting Started Getting Started with JSDoc 3 A quick-start to documenting JavaScript with JSDoc. Using namepaths with JSDoc 3 A guide to using namepaths with JSDoc 3. Command-line arguments to JSDoc About command-line arguments to JSDoc. Configuring jsdoc.app Getting Started with JSDoc 3 JSDoc 3 (최신버전) 이란? - JavaScript를 위한 API 문서 생성기 - 소스코드에 직접 코멘트..