[Clean Code] 형식 맞추기

1. 형식 맞추기

코드형식은 매우 중요합니다. 코드 형식은 의사소통의 일환입니다. 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미칩니다. 그러면 장려하는 코드 형식에 대해서 알아보겠습니다.

 

[적절한 행 길이를 유지하라]

소스코드는 얼마나 길어야 적당할까요? 그림 5.1은 프로젝트 7개를 나타냅니다. 상자를 관통하는 선은 각 프로젝트에서 최대 파일의 길이와 최소 파일 길이를 나타냅니다. 상자는 대략 파일의 1/3을 차지합니다. 상자 중간이 평균입니다.

 

 

JUnit, FiteNesse, Time and Money는 상대적으로 파일 크기가 작습니다. 500줄을 넘어가는 파일이 없으며 대다수가 200줄 미만입니다. 반면, Tomcat과 Ant는 절반 이상이 200줄을 넘어서고 심지어 수천 줄이 넘어가는 파일도 있습니다. 그림 5.1은 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는걸 말해주고 있습니다. 반드시 지킬 엄격한 규칙은 아니지만 바람직한 규칙으로 삼는걸 권장합니다.

 

[신문 기사처럼 작성하라]

이름은 간단하면서 설명이 가능하게 짓습니다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명합니다. 아래로 내려갈수록 의도를 세세하게 묘사합니다. 신문은 다양한 기사로 이뤄집니다. 대다수의 기사가 아주 짧습니다.

 

[개념은 빈행으로 분리하라]

일련의 행묶음은 완결된 생각 하나를 표현하며, 생각 사이는 빈행을 넣어 분리합니다. 코드를 읽어 내려가다 보면 빈행 바로 다음줄에 눈길이 멈춥니다. 이렇게 빈행을 줌으로써 가독성을 늘릴 수 있습니다.

 

[세로밀집도]

줄바꿈이 개념을 분리한다면, 세로 밀집도는 연관성을 의미합니다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓아야합니다.

public class ReporterConfig{

    /*
     * 리포터 리스너의 클래스 이름
     */
 	private String m_CLASSnAME;
   
    /*
     * 리포터 리스너의 속성
     */
     private List<Property> m_properties = new ArrayList<Property>();
     public void addProperty(Property property){
     	m_properties.add(property);
     }

}

위의 코드를 보면 의미없는 주석으로 두 인스턴스 변수를 떨어뜨려 놓았습니다. 아래 코드가 훨씬 더 읽기 쉽고 한눈에 들어옵니다.

public class ReporterConfig{

    private String m_className;
    private List<Property> m_properties = new ArrayList<Property>();   
	
    public void addProperty(Property property){
    	m_properties.add(property);
    }

}

[수직거리]

함수 연관 관계와 동작 방식을 이해하려고 이 함수에서 저 함수로 오가며 소스 파일을 위아래로 뒤지는 뺑뺑이를 해본 경험이 있을 것입니다. 이 조각 저 조각이 어디에 있는지 찾고 기억하느라 시간과 노력을 소모합니다. 서로 밀접한 개념은 세로로 가까이 둬야합니다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않습니다. 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현합니다.

 

[변수선언]

변수는 사용하는 위치에 최대한 가까이 선언합니다.

 

[종속함수]

한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치합니다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치합니다. 그러면 프로그램이 자연스럽게 읽힙니다. 이 규칙을 일괄적으로 작성한다면 독자는 방금 호출한 함수가 잠시 후에 정의되라는 사실을 예측할 수 있습니다.

 

[개념적 유사성]

어떤 코드는 서로끌어당깁니다. 개념적 친화도가 높을수록 가까이 배치합니다. 친화도가 높은 요인은 여러 가지가 있습니다. 앞에서 봤듯이 한 함수가 다른 함수를 호출해서 생기는 직접적인 종속성이 예시입니다. 비슷한 동작을 수행하는 일군의 함수가 좋은 예시입니다. 다음은 Junit 4.3.1에서 가져온 코드입니다.

위 함수들은 개념적인 친화도가 매우 높습니다. 명명법이 똑같고 기본 기능이 유사하고 간단합니다.

public class Assert{

    static public void assertTrue(String message, boolean condition){
    	if(!condition)
            fail(message);
    }
    
    static public void assertTrue(boolean condition){
    	assertTrue(null, condition);
    }
    
    static public void assertFalse(String message, boolean condition){
    	assertTrue(message, !condition);
    }

}

[가로 형식 맞추기]

한 행은 가로로 얼마나 길어야 적당할까요? 긴행보다는 짧은 행이 바람직합니다. 120자 정도로 행길이를 제한하는 것을 추천합니다.

 

[가로 공백과 밀집도]

가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현합니다.

public void measureLine(String line){
    lineCount++;
    int lineSize = line.length();
    totalChars  += lineSize;
    lineWidthHistogram.addLine(lineSize, lineCount);
    recordWidestLine(lineSize);
}

위의 코드는 할당 연산자를 강조하려고 앞뒤에 공백을 주었고, 함수 이름과 이어지는 괄호 사이는 서로 밀접하기 때문에 공백을 주지 않았습니다. 연산자 우선 순위를 강조하기 위해서도 쉼표 뒤에 공백을 주기도합니다.

 

[가로 정렬]

public class FitNessExpediter implemetns ResponseSender{

    private Socket         socket;
    private FitNessContext context;
    private long           requestParsingTimeLimit;

}

위와 같은 정렬은 별로 유용하지 않습니다. 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문입니다. 선언부를 읽다 보면 변수 유형은 무시하고 변수 이름부터 읽게 됩니다. 또한 코드 형식을 자동으로 맞춰주는 도구는 대다수가 위와 같은 정렬을 무시합니다.

 

정렬이 필요할 정도로 목록이 길어진다면 문제는 목록 길이지 저열ㄹ 부족이 아닙니다. 선언부가 길다면 클래스를 쪼개야 한다는 의미입니다.

 

[팀규칙]

프로그래머라면 각자 선호하는 규칙이 있습니다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙입니다. 팀은 한가지 규칙에 합의해야 합니다. 그리고 모든 팀원은 그 규칙을 따라야 합니다. 그래야 소프트웨어가 일관적인 스타일을 보입니다. 개개인이 따로 국밥처럼 마음대로 짜는 코드는 피해야합니다.

 

괄호를 어디에 넣을지, 들여쓰기는 몇자로 할지, 클래스와 변수와 메서드 이름은 어떻게 지을지 등을 결정합니다. 그리고 팀원끼리 정한 규칙으로 IDE 코드 형식기를 설정한 후 사용합니다. 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄지어야합니다. 한 소스 파일에서 봤던 형식은 다른 소스 파일에도 쓰이라는 신뢰감을 독자에게 주어야합니다.