[JavaScript_study] 주석 (Comments)

* 주석 (Comments)

• 주석은 코드 자체를 설명하는 것이 아니라, 왜(WHY) 이런 아키텍쳐를 선택했는지 그리고 어떻게(HOW)이 모듈을 사용해야 하는지를 설명하는것이 좋음 (단, 정말 필요한 경우에만)
• 외부에서 많이 쓰이는 함수 API인 경우 JSDoc를 사용하면 좋음
  • /** */ 형식의 주석

• // 한줄 짜리 주석을 작성할 때 사용
  • ex) // TODO(latte) : 해야할 일 작성
  • ex) // TODO(latte) : xx기능 구현하기

* 주석 사용 예시

// 외부에서 많이 쓰이는 함수 API인 경우 JSDoc을 사용하면 좋음
// 첫줄에는 함수에 대한 설명 작성
/**
 * 주어진 두 인자를 더한 값을 반환함
 * @param {*} a 숫자 1
 * @param {*} b 숫자 2
 * @returns a와 b를 더한값
 */
function add(a, b) {
  return a + b;
}

// ctrl + 클릭을 이용해 해당 함수의 설명에 들어가보면 JSDoc에 대해 좀 더 파악이 가능하다.
[].map;