JSDoc
회사 libs를 보는데 @param
, @returns
같은 것들이 쓰여있었다
예전에도 이런 것들을 본적이 있었는데 그때는 그냥 그러려니 하고 넘어갔지만
지금은 넘어갈 수 있는 상황이 아니라 찾아봤다
1. JSDoc
이러한 문서를 JSDoc
이라고 하는데 Javadoc
과 유사한 js
용 API문서 생성기로 주석을 통해 코드의 설명을 추가할 수 있다
2. 사용법
간단하게 덧셈을 연산하는 함수에 대해 JSDoc
을 작성해보면
/** @function addition
* @param {number} a 연산하고자 하는 0 이상의 정수
* @param {number} b 연산하고자 하는 0 이상의 정수
* @returns {number} a + b
*/
const addition = (a, b) => a + b;
이런느낌일 것 같다
3. TL; DR
딱히 요약할 것도 없다
/** ... */
으로 주석처리 되어있고 안에 @param
같이 @
prefix가 붙어있다면 주석으로 문서화를 하는 JSDoc 문법이라는 것을 인지하면 된다
*References
Author And Source
이 문제에 관하여(JSDoc), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://velog.io/@ayaan92/JSDoc저자 귀속: 원작자 정보가 원작자 URL에 포함되어 있으며 저작권은 원작자 소유입니다.
우수한 개발자 콘텐츠 발견에 전념 (Collection and Share based on the CC Protocol.)