[typescript] 객체 분해 할당과 프로퍼티 셋터/게터를 사용한 코드 문서화 방법

12 Dec 2023

typescript

소개

이번 포스트에서는 TypeScript와 객체 분해 할당, 그리고 프로퍼티 셋터와 게터를 사용하여 코드를 작성하고 문서화하는 방법에 대해 알아보겠습니다.

객체 분해 할당

TypeScript에서 객체 분해 할당은 객체의 프로퍼티를 빠르게 추출하여 변수에 할당하는 기능을 제공합니다. 다음은 간단한 예제입니다.

// 예제 1: 기본 객체 분해 할당
const person = {
  name: "John",
  age: 30
};

const { name, age } = person;
console.log(name); // 출력: "John"
console.log(age); // 출력: 30

// 예제 2: 객체 분해 할당과 기본 값
const { name: myName, age: myAge = 25 } = person;
console.log(myName); // 출력: "John"
console.log(myAge); // 출력: 30

프로퍼티 셋터와 게터

TypeScript에서 프로퍼티 셋터(setter)와 게터(getter)를 사용하여 객체의 프로퍼티에 대한 값을 설정하고 가져올 수 있습니다.

class Circle {
  private _radius: number = 0;

  get radius(): number {
    return this._radius;
  }

  set radius(value: number) {
    if (value < 0) {
      throw new Error("반지름은 음수일 수 없습니다.");
    }
    this._radius = value;
  }
}

const myCircle = new Circle();
myCircle.radius = 5;
console.log(myCircle.radius); // 출력: 5

코드 문서화

코드를 문서화하는 것은 개발자들이 코드를 이해하고 유지보수하는 데 도움이 됩니다. TypeScript에서는 JSDoc을 사용하여 코드에 주석을 추가하여 문서화할 수 있습니다.

/**
 * 원의 넓이를 계산하는 함수
 * @param {number} radius - 원의 반지름
 * @returns {number} 원의 넓이
 */
function calculateArea(radius: number): number {
  return Math.PI * radius ** 2;
}

이렇게 코드를 문서화하면 IDE나 도구를 통해 코드에 대한 정보를 빠르게 확인할 수 있습니다.

결론

이러한 TypeScript의 기능들을 이용하여 코드를 작성하고 문서화하면 코드의 가독성과 유지보수성을 높일 수 있습니다.

소개

목차

객체 분해 할당

프로퍼티 셋터와 게터

코드 문서화

결론

참고 자료