[React] 자바스크립트 주석

다른 개발자와의 협업, 자바스크립트의 불명확한 type을 위해 자바스크립트 함수에는 주석을 통한 문서화로 내용을 작성하면 많은 도움이 된다.
JSDoc이라는 특별한 문법을 사용하면 함수에 관한 문서를 쉽게 작성할 수 있다.

  /**
 * k,m,b 숫자단위 계산. 소수점 2자리 표시
 * @todo 메모 (ex.개발을 추가로 해야 될 사항 같은 거)
 * @version 1.3.0
 * @see https://naver.com
 * @param {number} num 항목에 대한 고유 식별자
 * @returns {string} 소수점 제거값
 */
  const kmbtCalc = (num) => {
    if (num < 1000000) return `${(num / 1000).toFixed(2)}k`;
    if (num < 1000000000) return `${(num / 1000000).toFixed(2)}m`;
    if (num < 1000000000000) return `${(num / 1000000000).toFixed(2)}b`;
  };

• 함수 기능설명
• @author - 함수를 누가 작성했는지를 통해 협업시 그사람에게 도움요청 가능
• @todo - (ex.추가로 개발해야 될 사항)
• @version - 수정 버전
• @see - 함수 관련 참고 자료 링크
• @param - 함수의 매개변수 설명
• @return - 함수의 리턴값 설명

그 외에도 다양한 @어노테이션은 아래 링크 참조
jsdoc 문서 @어노테이션