[c#] C# 코드 리뷰 시 변수 및 메소드 네이밍 규칙

26 Dec 2023

소프트웨어 개발에서 명확하고 일관된 네이밍 규칙은 코드의 가독성을 향상시키고 유지보수를 용이하게 만듭니다. C# 코드를 리뷰할 때 변수와 메소드 네이밍을 다루는 가이드라인은 다양한 프로젝트에서 적용할 수 있는 중요한 주제입니다.

1. 변수 네이밍

변수 이름은 해당 변수가 하는 일을 나타내도록 짓는 것이 중요합니다. 일반적으로 다음과 같은 네이밍 규칙을 따릅니다.

의미 있는 이름 사용: 변수의 목적과 사용 방법을 파악하기 쉽도록 이름을 지어야 합니다.
```
// 좋은 예
int studentCount;
  
// 나쁜 예
int x;
```
카멜 케이스: 다소어를 사용할 때, 카멜 케이스 (첫 글자는 소문자로 시작하고, 이후 단어의 첫 글자는 대문자인 방식)를 사용하는 것이 일반적입니다.
```
string userName;
```
의미 있는 약어 사용: 일반적으로 단어의 약어를 사용하지 않는 것이 좋지만, C# 커뮤니티에서 널리 알려진 약어는 사용할 수 있습니다.
```
int tempVal;
```

메소드의 이름도 기능과 목적을 잘 설명하도록 짓는 것이 중요합니다. 다음 규칙을 준수할 수 있어야 합니다.

동사-명사 구조: 메소드 이름은 해당 메소드가 하는 일을 나타내도록 짓는 것이 중요합니다.
```
// 좋은 예
void calculateTotal();
  
// 나쁜 예
void total();
```
카멜 케이스: 메소드 이름도 변수와 마찬가지로 카멜 케이스를 사용하는 것이 좋습니다.
```
void updateUserDetails();
```

코드 리뷰 시 변수와 메소드의 네이밍 규칙을 준수하는 것은 코드의 가독성을 향상시키고 유지보수를 더 용이하게 만듭니다. 이러한 네이밍 규칙을 지켜 작성한 코드는 개발자들 간의 협업을 더욱 향상시킬 수 있습니다.

유용한 참고 자료입니다.