# JSDoc
JSDoc 사용해서 문서화하기 (feat. Github Pages 배포)
JavaScript의 API를 문서화하는 툴이다. JSDoc에서 제공하는 태그를 이용해서 클래스, 함수, 모듈, 메서드, 파라미터 등을 문서화한다. 여러 종류의 태그들이 있어서 잘 사용하면 구체적인 정보가 담긴 문서를 만들 수 있다.jsdoc.appJSDoc 3.6 한
타입스크립트 Vs Jsdoc 개인의 선택은??
팀 단위로 개발을 하다보면 코드를 작성하여 개발을 하는 것 보다 훨씬 더 중요한 것이 있는데. 그것은 바로 나의 팀원들을 위한 코드를 작성해야한다.
[jsdoc] 사용해보기
원티드 프리온보딩 신청을 또 했다.내일까지 과제를 해야하는데... 포폴을 만드느라고 이제야 시작해보려고 한다 흑흑jsdoc 홈페이지(https://jsdoc.app/index.html\[jsdoc 깃허브 레포지토리](https://github.com/
[내일배움캠프] TIL_230125
"include": js로 컴파일하고싶은 디렉토리"compilerOptions": { "outDir": 컴파일된 js가 저장 될 디렉토리, "target": js로 컴파일 할 ECMA버전, "lib": 어떤버전의 js가 사용되는지 그 환경, 브라우저위에서 실행하려
[SeSAC Front-end] VSCode에서 '주석'을 어떻게 효율적으로 달까? (with JSDoc)
0. Intro 이번 장에서는 VSCode에서 javascript 코드를 생성할 때, 주석을 더 효율적으로 다는 방법에 대해서 알아보겠습니다. 이 장을 보면, JSDoc 이라는 개념에 대해서 이해할 수 있습니다. 또 함수나 변수, 객체에 타입이나 설명 등 여러가지 정
JSDoc
자바스크립트 소스 코드 파일들에 주해를 달기 위해 사용하는 마크업 언어이다.자바스크립트에 타입 힌트를 제공할 수 있다.JSDoc 주석은 /\*\* ... \*/ 사이에 기술한다. author은 항목의 작성자를 나타낸다.이름 뒤에 꺾쇠를 넣고 이메일을 추가한다.매개변수의
JSDoc과 사용법
[JSDoc] 주석을 고급 개발처럼 보이게 달아주는 기능 : '/* /'형태 협업할 때 라이브러리, 코드에 대해 jsdoc를 통해 자세히 설명해 놓는 것을 권장 아래와 같이 주석을 작성해주게 되면 나중에 해당 함수를 작성할 때 'hello'함수에 mouseover만 해
jsDoc 사용하기 & 사용 예시(param, typeDef, enum 등)
jsDoc은 자바스크립트 소스코드에 주석을 달기 위해 사용하는 마크업 언어이다. (위키백과)jsDoc은 단순히 js 소스코드에 단순히 주석을 작성하는 것을 넘어, IDE에게 메소드의 매개변수, 리턴타입 힌트를 주어 자동완성 지원하도록 하는 것 까지 가능하다. 이를 통해
JS => TS
이전에 작성했던 JS코드에 더해 TS코드를 짜고 싶지만 JS코드는 건들고 싶지 않을 때에는tsconfig.json파일안에를 해줘서 TS안에 JS를 허용해주면 된다.하지만 이렇게 하면 JS코드는 타입 보호를 받기 어렵기 때문에코드 유지보수를 할 때 자동완성이라던가 에러
JSDoc
JSDoc이란 JavaScript용 API 문서 생성기이다. API 코드 작성시 /\*\*으로 시작하는 주석을 인식하여 API를 설명하는 HTML 문서를 생성해준다.참고: /\*로 시작하는 일반 주석은 무시된다
JSDoc
회사 libs를 보는데 @param, @returns같은 것들이 쓰여있었다예전에도 이런 것들을 본적이 있었는데 그때는 그냥 그러려니 하고 넘어갔지만지금은 넘어갈 수 있는 상황이 아니라 찾아봤다이러한 문서를 JSDoc이라고 하는데 Javadoc과 유사한 js용 API문서
[부록] TS, 왜 써야할까?
타입스크립트, 까다롭기만한데 굳이 왜 써야할까?에 대한 가벼운 이야기를 다룹니다. 본 게시물은 프론트엔드와 백엔드 개발자 모두가 이해할 수 있는 수준으로 작성되었습니다 :)
jsdoc 사용하기
jsdoc 자바스크립트로 개발하다보면 자바나 C++같은 언어처럼 타입 힌팅이 되거나 코드 인텔리전스가 되었으면 하는 경우가 있다. 최근에 타입스크립트가 사용되면서 이런 문제가 많이 해결되었지만, 아직 많은 프로젝트는 자바스크립트로 작성되어 있고, 이를 위해서 타입스크
JSDoc은 대소문자를 구분할까?
JSDoc문서에서 parameter와 return 타입을 보다가 "JSDoc은 대소문자를 구분하는가? 그리고 대소문자가 중요할까?"에 대한 궁금함이 생겼다.우선 정답부터 말하자면 "구분하지 않는다."나와 동일한 생각을 한 질문자가 있는데 답변을 참고하면 JSDoc은 대