주석

박현석·2022년 9월 2일
1

Javascript ES6+

목록 보기
67/88
// 주석 Comments
// 한줄 짜리 주석을 작성할 떄 씀
// TODO(엘리): 해야할 일을 작성
// TODO(엘리): XX기능 구현하기

/**
 * 주석은 코드 자체를 설명하는 것이 아니라,
 * 왜(WHY)와 어떻게(HOW)를 설명하는것이 좋음
 * (단, 정말 필요한 경우에만)
 */

// 외부에서 많이 쓰이는 함수 API인 경우 JSDoc을 사용하면 좋음
/**
 * 주어진 두 인자를 더한 값을 반환함
 * @param {*} a 숫자 1
 * @param {*} b 숫자 2
 * @returns a와 b를 더한값
 */
function add(a, b) {
  return a + b;
}
[].map;
profile
선한 영향력을 주는 사람

0개의 댓글