[CleanCode] 검색하기 쉬운 이름을 사용하라

문자 하나를 사용하는 이름과 상수는 텍스트 코드에서 쉽게 눈에 띄지 않는다는 문제점이 있다.

로버트 C. 마틴, 《클린코드》, 박재호·이해영 옮김, 인사이트, 2013, 28쪽

 

1. 문자 하나로 된 변수와 상수 사용 예제

• c와 x와 같은 짧은 변수명은 그 의미를 충분히 전달하지 못하고, 코드의 목적을 이해하기 어렵게 만듭니다.

public class StudentRegistration {
    public static void main(String[] args) {
        int c = 7; // 최대 수업 수
        int x = 8; // 학생이 신청한 수업 수

        if (x > c) {
            System.out.println("학생이 신청할 수 있는 최대 수업 수를 초과했습니다.");
        }
    }
}

2. 숫자 리터럴 사용 예제

• 숫자 7이 코드에서 직접 사용되면, 이 값이 무엇을 의미하는지 알기 어렵고, 유지보수 시 숫자의 의미를 파악하거나 변경하기가 어렵습니다.

public class StudentRegistration {
    public static void main(String[] args) {
        int studentClassesEnrolled = 8;

        // 최대 수업 수를 숫자 리터럴로 사용
        if (studentClassesEnrolled > 7) {
            System.out.println("학생이 신청할 수 있는 최대 수업 수를 초과했습니다.");
        }
    }
}

1번과 2번의 예제는 변수나 상수를 문자 하나로만 사용하거나 숫자 리터럴을 직접 코드에 포함시켜 의미 전달의 부족, 가독성 저하, 유지보수의 어려움 문제를 초래합니다. 이를 해결하기 위해 아래 3번 예제에서는 의미 있는 변수명과 상수를 사용하여 코드의 가독성과 유지 보수성을 개선한 방법을 보여줍니다.

 

3. 의미 있는 변수와 상수 이름 사용 예제

• MAX_CLASSES_PER_STUDENT와 같은 의미 있는 상수명을 사용하면, 코드가 명확해지고 유지보수가 용이해집니다. 상수의 이름을 통해 그 값이 어떤 역할을 하는지 직관적으로 이해할 수 있습니다.

public class StudentRegistration {
	// 의미 있는 이름을 가진 상수 사용
    public static final int MAX_CLASSES_PER_STUDENT = 7;

    public static void main(String[] args) {
        int studentClassesEnrolled = 8; // 학생이 신청한 수업 수

        if (studentClassesEnrolled > MAX_CLASSES_PER_STUDENT) {
            System.out.println("학생이 신청할 수 있는 최대 수업 수를 초과했습니다.");
        }
    }
}

끝.