[c#] 코드 냄새 제거

18 Dec 2023

C# 언어로 프로그래밍을 하다보면 코드 냄새가 생길 수 있습니다. 코드 냄새란 유지보수가 어려운, 생산성을 저하시키는, 또는 성능에 영향을 주는 코드를 의미합니다. 이러한 코드 냄새를 제거하고 효율적인 코드를 작성하기 위해 몇 가지 방법을 살펴보겠습니다.

1. 중복 코드 제거

중복 코드는 유지보수와 확장이 어렵습니다. 중복 코드를 발견하면 메서드나 클래스로 추출하여 코드의 재사용성을 높이세요.

예시:

// 중복 코드
void PrintInfo(string name, int age)
{
    Console.WriteLine($"Name: {name}");
    Console.WriteLine($"Age: {age}");
}

void PrintDetails(string name, int age)
{
    Console.WriteLine($"Details - Name: {name}, Age: {age}");
}

중복 코드를 메서드로 추출:

void PrintInfo(string name, int age)
{
    Console.WriteLine($"Name: {name}");
    Console.WriteLine($"Age: {age}");
}

void PrintDetails(string name, int age)
{
    PrintInfo(name, age);
    Console.WriteLine($"Details - Name: {name}, Age: {age}");
}

2. 의미 있는 이름 사용

의미 있는 이름을 사용하여 코드의 가독성을 높이세요. 변수, 메서드, 클래스 등의 이름을 명확하게 지으면 유지보수가 쉬워지며 코드 이해가 쉬워집니다.

예시:

// 의미 있는 이름 사용 전
int x = 5; // 변수명이 x로만 되어 있어 의도를 파악하기 어려움

// 의미 있는 이름 사용 후
int numberOfUsers = 5; // 변수명이 numberOfUsers로 변경하여 의도를 명확히 함

3. 불필요한 주석 제거

의미 있는 이름을 사용하여 코드 자체가 설명이 되도록 하고, 불필요한 주석을 제거하세요. 주석이 코드를 설명하는 것이 아니라 코드에 의미 있는 이름을 사용하여 주석을 최소화하세요.

예시:

// 불필요한 주석 제거 전
// 변수에 5 더하기
int result = x + 5;

// 불필요한 주석 제거 후
int result = numberOfUsers + 5; // numberOfUsers에 5를 더한 결과를 저장

결론

코드 냄새는 코드의 품질을 떨어뜨릴 수 있으며, 유지보수와 확장에 어려움을 초래할 수 있습니다. 중복 코드 제거, 의미 있는 이름 사용, 불필요한 주석 제거 등의 방법을 통해 코드 냄새를 제거하고 효율적인 코드를 작성하세요. 이를 통해 코드의 가독성을 높이고 유지보수가 쉬운 코드를 작성할 수 있습니다.

참고 문헌:

https://refactoring.guru/refactoring
https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/