Software Develop/코드규칙 3

[코드규칙] 변수 네이밍 규칙

변수명을 작성할 때에는 아래의 규칙을 반드시 적용한다 본 포스팅의 변수 네이밍 규칙은 필자의 규칙이므로 옳고 틀림의 문제가 아님을 알려드립니다. 특징 가독성을 확보할 수 있다. 변수명만으로 의미를 설명할 수 있다. 협업시 코드에 대한 이해도를 높힐 수 있다. 규칙 const 변수는 모두 대문자로 표기하고 띄어쓰기를 '_'로 구분한다. // 비권장 public const double MaxHeight = 10; // 권장 public const double MAX_HEIGHT = 10; var을 사용하고 변수명을 통해 변수의 데이터 타입을 유추할 수 있도록 한다. // 비권장 string str = ""; // 권장 var str = ""; 복수형의 데이터는 -s를 붙혀 복수의 의미를 부여한다. // 비권..

[코드규칙] Partial 클래스 사용

클래스 내용이 길어지면 기능별 partial 클래스로 분리한다. 특징 기능별로 유지보수가 용이하다. (문제 발생시 추적 확인 용이) 파일명으로 클래스의 기능을 파악할 수 있다. 예시 나쁜 예) Restaurant.cs public class Restaurant { public void OrderFood() { ... } public void OrderWater() { ... } public void OrderAlcohol() { ... } public void OrderDesert() { ... } public void WashDish() { ... } public void WashCup() { ... } public void WashFork() { ... } public void WashKnife() ..

[코드규칙] 함수 생성 규칙

1 함수 - 1 기능 하나의 함수는 하나의 기능만 구현해야한다. 특징 함수명으로 역할 및 기능을 알 수 있다. 재사용성 증가 단위 테스트 용이 예시 나쁜 예) public class Person { public string Name { get; set; } public void SetNameAndExportToFile(string name, string filePath) { Name = name; using(var sr = new StreamReader(filePath)) { sr.WriteLine(Name); } } } static void Main() { var name = "james"; var path = @"D:\"; var person = new Person(); person.SetNameAn..