Naming Convention [TypeScript]

Naming Convention

• 시간이 지나서 코드를 재사용하려는 경우 또는 작성자를 제외한 다른 개발자가 식별자 이름을 보고 더 나은 이해 및 활용을 할 수 있기 위해 사용한다.
• 현재 사용하고 있는 TypeScript 언어 개발 및 프레임워크 등에 적용하는 Naming Convention은 Camel Case, Snake Case, Pascal Case, Kebab Case 등이 있다.

Camel Case

• 각 단어의 첫글자는 소문자로 시작, 나머지 단어의 첫 글자는 대문자로 작성
  예시 )

  calculateTotalAmount

Pascal Case (=Upper Camel Case)

• 각 단어의 첫 글자를 대문자로 시작
  예시 )

  CalculateTotalAmount

Snake Case

• 각 단어를 소문자로 작성하고 단어 사이에 언더스코어( _ )를 사용한다.
  예시 )

  calculate_total_amount

Kebab Case (=Spinal Case)

• 각 단어를 소문자로 작성하고 단어 사이에 하이픈 (-)을 사용한다.
  예시 )

calculate-total-amount

Hungarian Notation

• 변수명에 변수의 타입을 포함시키는 방식
  예시 )

intCount, intCalculateTotalAmount

Abbreviations

• 가능한 모든 단어를 축약하지 않고, 일반적으로 사용되는 약어만 사용
  예시 )

getUserInfo(), getUserStat() => Statistics

Meaningful Names

• 변수나 함수의 이름은 해당 역할이나 의미를 잘나타내야 함
  예시 )

calculateTotalAmount (X) => calculateInvoiceTotalAmount (O)

---

TypeScript notation naming guide (TypeScript 변수 및 객체 이름 표기 설명서)

Variable And Function (변수와 함수)

• Camel Case를 Variable 과 Function에 사용한다.
  예시 )

  const fooVar;
  function barFunc(){}

Class (클래스), Method (메소드)

• Pascal Case 를 사용한다.
  예시 )

  class Foo {}
  
  class Foo {
      bar : number;
      baz() {}
  }

Interface (인터페이스)

• 이름은 Pascal Case를 사용 구성요소는 Camel Case를 사용
  예시 )

  interface Foo {}

Enum

• Pascal Case를 사용, Enum의 구성요소 또한 Pascal Case를 사용
  예시 )

  enum Color {
      Red
  }

Filename (파일명)

• Kebab Case (=Spinal Case)

예시 )

create-user-info.dto.ts

---

TypeScript notation naming guide 참고 사이트

Understanding TypeScript’s type notation

StyleGuide