[Java] 코드의 가독성을 높이는 공백 라인 리팩토링

민경담·2024년 8월 1일

Java 공백 라인 리팩토링

자바 리팩토링

목록 보기

4/6

들어가며

코드를 작성할 때는 가독성은 가장 중요한 요소입니다.

특히, 다른 개발자와 협업하는 팀 프로젝트의 경우에는 코드를 이해하기 쉽게 유지하는 것이 필수적입니다.

공백 라인 은 코드의 가독성을 높이는 요소 중 하나입니다.

코드의 논리적 단락을 분리하여 이해하기 쉽게 만들어주는 공백 라인에 대해 알아보겠습니다.

공백 라인

공백 라인은 리팩토링 시 생각할 수 있는 특성인 가독성과 유지보수성 측면에서 높일 수 있는 기법 중 하나라고 할 수 있습니다.

public class Example {
    public void process() {
        int a = 10;
        int b = 20;
        int sum = a + b;
        if (sum > 20) {
            System.out.println("Sum is greater than 20");
        } else {
            System.out.println("Sum is less or equal to 20");
        }
        for (int i = 0; i < 10; i++) {
            System.out.println(i);
        }
        System.out.println("Process Complete");
    }
}

위 코드 예시를 보면 a와 b의 값을 더해서 결과값을 콘솔에 출력하는 예시입니다.

쉬운 코드 예시이기 때문에 굳이 공백을 사용하지 않고도 사용자가 쉽게 파악할 수 있지만

내용이 복잡한 프로덕션 코드의 경우에는 이해하기 어렵게 됩니다.

public class Example {

    public void process() {
        int a = 10;
        int b = 20;

        int sum = a + b;

        if (sum > 20) {
            System.out.println("Sum is greater than 20");
        } else {
            System.out.println("Sum is less or equal to 20");
        }

        for (int i = 0; i < 10; i++) {
            System.out.println(i);
        }

        System.out.println("Process Complete");
    }
}

이전 코드에 공백 라인을 사용하여 리팩토링한 코드입니다.

공백 라인을 사용하면 코드의 구조를 명확하게 하고, 논리적인 흐름을 쉽게 파악할 수 있습니다.

또한, 구분이 되어 있기에, 유지보수 및 디버깅 시간을 단축시킬 수 있습니다.

공백 라인 삽입 시 고려 사항❗

공백 라인을 삽입 시에는 고려할 사항은

첫째, 논리적인 단락을 구분 한다.
각 기능과 블록 사이에는 공백 라인을 추가하여 논리적 단락을 명확하게 구분해야합니다.

//논리적 구분 리팩토링 전
public class Main {
    public static void main(String[] args) {
        int a = 10;
        int b = 20;
        int sum = a + b;
        System.out.println("Sum: " + sum);
        int difference = a - b;
        System.out.println("Difference: " + difference);
    }
}

//논리적 구분 리팩토링 후
public class Main {
    public static void main(String[] args) {
        int a = 10;
        int b = 20;

        // 덧셈 연산
        int sum = a + b;
        System.out.println("Sum: " + sum);

        // 뺄셈 연산
        int difference = a - b;
        System.out.println("Difference: " + difference);
    }
}