갈푸라떼
갈푸라떼는 개발중
갈푸라떼
전체 방문자
오늘
어제
  • 분류 전체보기 (232)
    • CS (0)
      • CSinfo (0)
    • Frontend (15)
      • HTML,CSS (1)
      • Javascript (2)
      • React (0)
      • React Hook (12)
    • Backend (0)
      • Python (0)
      • Node.js (0)
      • php (0)
    • DB (2)
      • MySQL (2)
      • BigQuery (0)
      • Mongodb (0)
    • Study (186)
      • JavaScript (72)
      • JavaScript(Clean code) (50)
      • Node.js (11)
      • HTML,CSS (13)
      • React (30)
      • TypeScript (10)
      • React-Native (0)
    • Error (2)
      • error (2)
    • Git (22)
      • Git (22)
    • Help Coding (4)
      • Useful websites (3)

블로그 메뉴

  • 홈
  • 태그
  • 방명록
  • Github

공지사항

인기 글

태그

  • structure
  • Babel
  • 오버라이딩
  • 싱글스레드
  • ECMAScript
  • 프로토타입
  • 정적 레벨
  • 심볼
  • 네이밍
  • 상속
  • symbol
  • Arrow
  • 실행 컨텍스트
  • PM2
  • SPREAD
  • this
  • 객체타입
  • 컴파일러
  • 렉시컬 환경
  • prototype
  • nodemon
  • class
  • 원시타입
  • 스코프 체인
  • 인터프리터
  • 이터러블
  • function
  • 함수
  • 자바스크립트엔진
  • 호이스팅

최근 댓글

최근 글

티스토리

hELLO · Designed By 정상우.
갈푸라떼

갈푸라떼는 개발중

Study/JavaScript

[JavaScript_study] 주석 (Comments)

2022. 4. 12. 19:43

* 주석 (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;

'Study > JavaScript' 카테고리의 다른 글

[JavaScript_study] error-bubbling  (0) 2022.04.12
[JavaScript_study] 에러 핸들링(error-handling)  (0) 2022.04.12
[JavaScript_study] 널 병합 연산자(Nullish Coalescing Operator)  (0) 2022.04.12
[JavaScript_study] 옵셔널 체이닝 연산자 (Optional Chaining Operator)  (0) 2022.04.12
[JavaScript_study] 논리연산자, 단축평가(short-circuit evaluation)  (0) 2022.04.12
    'Study/JavaScript' 카테고리의 다른 글
    • [JavaScript_study] error-bubbling
    • [JavaScript_study] 에러 핸들링(error-handling)
    • [JavaScript_study] 널 병합 연산자(Nullish Coalescing Operator)
    • [JavaScript_study] 옵셔널 체이닝 연산자 (Optional Chaining Operator)
    갈푸라떼
    갈푸라떼

    티스토리툴바