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

• @use JSDoc
• JSDoc을 사용해 JavaScript 파일 문서화하기