[c#] C# 코드 리뷰 시 코드 가독성 향상 방법

26 Dec 2023

소프트웨어 개발에서 코드 가독성은 매우 중요합니다. 코드 리뷰 과정에서는 코드의 가독성을 높이고 유지보수를 쉽게 하기 위해 여러가지 방법을 사용할 수 있습니다. 여기에는 주석을 작성하고 코드를 모듈화하는 것뿐만 아니라 명확한 변수명과 함수명을 사용하는 것도 포함됩니다.

1. 주석 활용

주석은 코드의 이해를 돕는 중요한 도구입니다. 코드 리뷰 시에는 주석을 추가하거나 수정하여 코드의 목적과 비즈니스 규칙을 설명해야 합니다. 코드에 의도를 명확히 드러내는 주석을 작성해야 합니다.

// 주문을 생성하고 데이터베이스에 저장합니다.
void CreateOrder(Order order)
{
    // 주문 객체를 데이터베이스에 저장합니다.
    _database.Save(order);
}

2. 모듈화

코드를 모듈화하여 함수 또는 클래스의 크기를 작게 유지합니다. 단일 책임 원칙을 따르며 각 함수나 클래스는 하나의 목적을 가져야 합니다. 이를 통해 코드의 가독성을 향상시키고 유지보수를 쉽게 할 수 있습니다.

// 올바른 예: 주문 생성 기능만을 수행하는 함수
void CreateOrder(Order order)
{
    _database.Save(order);
}

// 잘못된 예: 여러 기능을 수행하는 함수
void GenerateReportAndCreateOrder(Order order, Report report)
{
    // ...
}

3. 명확한 변수명과 함수명

의미 있는 변수명과 함수명을 사용하여 코드를 작성합니다. 의미 있는 이름을 가진 변수와 함수는 코드를 이해하기 쉽게 만들어 줍니다.

// 좋은 변수명 사용
int totalOrderCount = GetTotalOrderCount();

// 나쁜 변수명 사용
int x = GetCount();

4. 코드 스타일 가이드 준수

코드 스타일을 일관되게 유지하여 가독성을 향상시킬 수 있습니다. 팀에서 합의한 코드 스타일 가이드를 준수하고, 코드 리뷰 시에도 일관된 코드 스타일을 유지해야 합니다.

참고문헌:

Microsoft, “C# Coding Conventions”: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions