Javascript 기초 (19) 좋은 주석

🙂좋은 주석에 대해서 아주 짧게🙂

🙅‍♀️ 좋지 않은 주석

• 코드에서 일어나는 일 -> 코드가 불분명하게 적어라
  (함수를 활용해서!)

🙆 좋은 주석

• 아키택처
• 함수 용례와 매개변수 정보를 담고 있는 주석
• 당장봐선 명확해 보이지 않는 해결방법에 대한 설명

🗒️ 함수 용례 작성 문법

태그	설명
@author	개발자 이름
@constructor	함수를 생성자로 표시합니다.
@deprecated	메서드를 더 이상 사용되지 않는 것으로 표시합니다.
@exception	@throws의 동의어
@exports	모듈에서 내보낸 멤버를 식별합니다.
@param	메서드 매개변수를 문서화합니다. 중괄호 사이에 데이터 유형 표시기를 추가할 수 있습니다. ex) @param {number} x 거듭제곱할 숫자
@private	멤버가 비공개임을 나타냅니다.
@returns	반환 값 문서화
@return	@returns의 동의어
@see	다른 개체에 대한 연결을 문서화합니다.
@todo	누락된/열린 것을 문서화합니다.
@this	키워드 this가 함수 내에서 참조하는 개체의 유형을 지정합니다.
@throws	메서드에 의해 발생한 예외를 문서화합니다.
@version	라이브러리의 버전 번호를 제공합니다.