Software Develop/코드규칙

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

jaywapp 2022. 3. 3. 22:05
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.SetNameAndExportToFile(name, path);
}

좋은 예)

public class Person
{
    public string Name { get; set; }
    
    public void SetName(string name)
    {
        Name = name;
    }
    
    public void ExportToFile(string filePath)
    {
        using(var sr = new StreamReader(filePath))
        {
            sr.WriteLine(Name);
        }
    }
}
static void Main()
{
    var name = "james";
    var path = @"D:\";
    
    var person = new Person();
    
    person.SetName(name);
    person.ExportToFile(filePath);
}

'Software Develop > 코드규칙' 카테고리의 다른 글

[코드규칙] 변수 네이밍 규칙  (0) 2022.03.09
[코드규칙] Partial 클래스 사용  (0) 2022.03.03