깔끔한 C# 코드 작성을 위한 5가지 (중요) 팁

C# 프로그래머의 가장 중요한 기술 중 하나는 잘 수행되고 다른 프로젝트로 이동한 후 코드를 상속할 다른 사람이 쉽게 유지 관리할 수 있는 깨끗하고 효율적인 코드를 작성하는 것입니다. 변수, 메서드, 클래스, 유형 등 C# 코드를 작성할 때 고려해야 할 요소가 많기 때문에 이는 불가능한 작업처럼 보일 수 있습니다. 하지만 이 5가지 팁을 통해 팀의 다른 사람들이 읽고 이해하기 쉬운 깔끔한 C# 코드를 작성하는 방법을 배울 수 있습니다.

기억하기 쉬운 변수 이름 사용

이 과실은 가장 흔한 것 중 하나입니다. 대부분의 경우에 필요하지 않은 경우에 우리는(.NET 개발자는) 많은 것을 복잡하게 만들고 싶어합니다.

변수를 선언할 때 이해하기 쉽고 기억하기 쉽고 발음하기 쉬운 이름을 사용해야 합니다.

나쁜 방법:

var yyyymmdstr = DateTime.Now.ToString("YYYY/MM/DD");

좋은 방법:

var currentDate = DateTime.Now.ToString("YYYY/MM/DD");

이것은 중요하지 않은 것 같지만 일단 프로젝트가 발전하고 규모가 커지면 변수의 수는 매우 커질 것입니다. 그리고 오랜 시간이 지난 후에 프로젝트를 열지 않고 열면 코드의 일부가 무엇을 하는지 알지 못하는 경우가 많다는 것을 우리 모두 알고 있습니다.

변수 이름 일관성

우리는 변수를 선언하지만 각 변수를 다른 구조로 선언하거나 '어휘적으로 말하면' 다른 어휘로 선언하는 일이 여러 번 발생했습니다. 설명하겠습니다.

우리는 항상 가장 단순함을 찾아야 합니다. 우리는 항상 같은 단어를 사용해야 하며 변경해서는 안 됩니다. 실제 예를 살펴보겠습니다.

나쁜 방법:

getUserInfo();
getClientData();
getCustomerRecord();

좋은 방법:

getUser();

이 예에서 우리는 나쁜 방식으로 같은 단어에 대해 다른 동의어를 사용하고 있음을 분명히 알 수 있습니다. 이는 현재 개발자와 코드를 이해해야 하는 (가능한) 미래 개발자 모두에게 미래에 혼란을 야기할 수 있습니다.

검색 가능한 이름 사용

한 번 이상 무언가가 어디에 있는지 잊어버리고 그 무언가를 찾기 시작하지만 변수에 지정한 이름을 기억하지 못하거나 이름을 직접 지정했는지 기억하지 못하기 때문에 찾을 수 없다고 확신합니다. 그 상수. 더 나은 이해를 위해:

나쁜 방법:

// In the future we will not remember what 86400000 means.
clearBacklog(backlog, 86400000);

좋은 방법:

// Declare constants with a searchable name
var MILLISECONDS_PER_DAY = 60 * 60 * 24 * 1000; //86400000;

clearBacklog(backlog, MILLISECONDS_PER_DAY);

비록 그 당시에는 그렇게 보이지 않을지 모르지만 이 작은 연습은 많은 검색 시간과 꽤 많은 골칫거리를 줄여줄 것입니다(현재 개발자와 잠재적인 미래 개발자 모두에게). 기억하세요: 코드는 읽기 쉬울수록 좋습니다.

반복하지 마세요

이 오류는 우리가 무의식적으로 이름이나 단어를 반복하기 때문에 매우 일반적입니다. 장기적으로 보면 이 나쁜 습관은 반복될 일이 많기 때문에 매우 지저분한 코드를 갖게 됩니다. 연습을 시작합시다.

나쁜 방법:

Bike MountainBike = new(){
   bikeBrand = "Trek",
   bikeModel = "MX Mountain",
   bikeColor = "Green"
};

void paintBike(Bike mountainBike, string color){
     mountainBike.bikeColor = color;
}

좋은 방법:

Bike MountainBike = new(){
   brand = "Trek",
   model = "MX Mountain",
   color = "Green"
};

void paintBike(Bike mountainBike, string color){
     mountainBike.color = color;
}

이런 식으로 우리는 생각하고 작성하는 시간을 줄임으로써 훨씬 더 깨끗하고 읽기 쉬운 코드를 얻을 수 있음을 알 수 있습니다.

매우 설명적인 변수 이름을 사용합니다.

또 다른 나쁜 습관은 함수를 다른 함수의 인수로 직접 보내는 것입니다. 이것은 많은 혼란을 야기할 뿐이고 우리의 머리를 구형 AMD FX 시리즈 프로세서보다 더 뜨겁게 만듭니다.

나쁜 방법:

const address = "One Infinite Loop, Cupertino 95014";
var cityZipCodeRegex = new Regex(@"/ ^[^,\\] +[,\\\s] + (.+?)\s * (\d{ 5 })?$/").Matches(address);
saveCityZipCode(
  cityZipCodeRegex[0].Value,
  cityZipCodeRegex[1].Value
);

좋은 방법:

var address = "One Infinite Loop, Cupertino 95014";
var cityZipCodeRegex = new Regex(@"/ ^[^,\\] +[,\\\s] + (.+?)\s * (\d{ 5 })?$/").Matches(address);
var city = cityZipCodeRegex[0].Value;
var zipCode = cityZipCodeRegex[1].Value;
saveCityZipCode(city, zipCode);

보시다시피 해결책은 결과 값을 변수에 추가한 다음 해당 변수를 함수로 보내는 것입니다. 이를 통해 귀하가 보내는 정보를 더 간단한 방식으로 이해할 수 있으며 그 외에도 머리에 Noctua 방열판을 저장할 수 있습니다.


나는 이 작은 팁들이 매우 간단하다는 것을 알고 있습니다. C#에서 더 깔끔한 코드를 작성하는 방법의 수는 우주보다 더 무한합니다. 따라서 Cleaner C# 코드 게시물 목록을 작성하여 코드의 품질을 개선하기 위한 고급 팁과 기타 요령을 다룰 것입니다.

관심이 있으신 분들은 팔로우를 잊지 마시고 소식을 놓치지 마세요!