Colin's Blog
[typescript] 코드 스타일 가이드를 작성할 때 문법 규칙을 어떻게 정해야 할까요?

목차

들어가기

TypeScript 코드 스타일 가이드를 작성할 때, 문법 규칙은 프로젝트의 요구 사항과 팀의 규칙을 고려하여 정해져야 합니다. 팀원들 간에 합의된 일관된 스타일을 유지하는 것이 중요합니다.

들여쓰기

들여쓰기 스타일은 2 스페이스로 하는 것을 권장합니다. 다른 팀원들과의 협업을 고려하여 일관된 스타일을 유지하는 것이 중요합니다.

// 좋은 예
function calculateTotal(price: number, quantity: number): number {
  return price * quantity;
}

// 나쁜 예 - 4 스페이스를 사용한 들여쓰기
function calculateTotal(price: number, quantity: number): number {
    return price * quantity;
}

네이밍 규칙

변수와 함수의 이름은 카멜 케이스를 사용하고, 클래스의 이름은 파스칼 케이스를 사용하는 것을 권장합니다.

// 좋은 예
const totalPrice: number = calculateTotal(10, 5);

class ShoppingCart {
  // 클래스 내용
}

// 나쁜 예 - 다른 네이밍 규칙 사용
const total_price: number = calculate_total(10, 5);

타입 별칭 사용

복잡한 타입이 필요한 경우, 타입 별칭을 사용하여 가독성을 높입니다.

// 좋은 예
type User = {
  id: number;
  name: string;
}

// 나쁜 예 - 타입 별칭을 사용하지 않은 복잡한 타입 정의
const user: { id: number; name: string } = { id: 1, name: 'John Doe' };

엔딩 콤마 사용

객체와 배열의 마지막 요소 뒤에 쉼표를 사용하는 것을 권장합니다. 이는 요소를 추가, 삭제, 이동할 때 발생할 수 있는 오류를 방지하고 코드 리뷰 과정에서 변경 사항을 추적하는 데 도움이 됩니다.

// 좋은 예
const fruits: string[] = ['apple', 'banana', 'orange',];

const person: User = {
  id: 1,
  name: 'John Doe',
};

// 나쁜 예 - 엔딩 콤마를 사용하지 않은 경우
const fruits: string[] = ['apple', 'banana', 'orange'];

const person: User = {
  id: 1,
  name: 'John Doe'
};

참조

© 2018 Colin. All rights reserved.