Clean Code -4 형식 맞추기

 

형식을 맞추는 목적

코드 형식은 매우 중요

의사소통의 일환이기 때문

맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지/보수의 용이성과 확장성에 지속적인 영향을 미친다

코드는 수정될지언정 개발자의 스타일과 규율은 계속해서 남아있기 때문에

 

 

적절한 행 길이를 유지하라

 

500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다

반드시 지킬 엄격한 규칙은 아니지만, 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다

 

신문기사처럼 작성하라

 

소스파일도 신문기사처럼 작성하라

이름은 간단하면서 설명이 가능하게

소스 파일 첫 부분은 고차원 개념, 알고리즘을 설명

아래로 내려갈수록 세세한 의도를 묘사

마지막에는 가장 저차원 함수와 세부 내역

 

 

개념은 빈 행으로 분리하라

 

대부분의 코드는 왼쪽에서 오른쪽으로

위에서 아래로 읽힌다

각자의 개념 사이에 빈 행을 넣어 완결됨을 표현하자

행 분리가 안되있다면 코드 가독성이 현저하게 떨어지고 피곤함을 유발한다

 

 

세로 밀집도

 

줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다

서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다

 

 

 

수직거리

 

서로 밀접한 개념은 세로로 가까이 두고 가능한 한 파일에 속해야 마땅하다

>> protected 변수를 피해야 하는 이유 중 하나

같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현

 

 

- 변수선언

변수는 사용하는 위치에 최대한 가깝게 선언한다

우리가 만들 함수는 짧으니까, 지역변수는 각 함수의 맨 위에 선언한다

    private static void readPreferences(){
        InputStream is = null;
        
        try{
            is = new FileInputStream(getPreferencesFile());
            setPreferences(new Properties(getPreferences()));
            
            ....
        }
        
    }

InputStream is 변수는 함수의 맨 위에 선언하고 바로 아래의 try 문에서 바로 사용된다

 

 

루프를 제어하는 변수는 루프문 안에 선언한다

    int count = 0;
    for (Test each : tests){
        count += each.countTestCases();
    }
    return count;

 

 

- 인스턴스 변수

인스턴스 변수는 클래스 맨 처음에 선언한다

변수 사이에 세로 거리를 두지 않는다

잘 설계한 클래스는 클래스의 많은 메서드가 인스턴스 변수를 사용하기 때문이다

 

 

- 종속함수

한 함수가 다른 함수를 호출한다면, 두 함수는 세로로 가까이 배치한다

또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다

 

    public void firstFunction(){
        int firstValue = secondFunction();
        ...
    }
    
    public int secondFunction(){
        ...
    }

호출되는 함수를 찾기가 쉬워지고, 그 만큼 모듈 전체의 가독성도 향상된다

 

 

- 개념적 유사성

개념적인 친화도가 높을수록 가까이 배치한다

한 함수가 다른 함수를 호출하며 생기는 종속성

변수와 그 변수를 사용하는 함수

비슷한 동작을 수행하는 함수들

 

 

public class Assert{
    static public void assertTrue(String message, boolean condition){
        ...
    }
    
    static public void assertTrue(boolean condition){
        ...
    }
    
    static public void assertFalse(String message, boolean condition){
        ...
    }
    
    static public void assertFalse(boolean condition){
        ...
    }
}

개념적인 친화도가 매우 높은 예시

기본 기능이 유사하고 서로가 서로를 호출하는 관계는 부차적인 요인

종속 관계가 없더라도 가까이 배치할 함수들

 

 

 

세로 순서

 

일반적으로 함수 호출 종속성은 아래방향으로 유지

신문기사처럼 가장 중요한 개념을 가장 먼저 표현 (세세한 사항 최대한 배제)

세세한 사항은 마지막에 표현

>> 독자가 소스를 읽을 때 첫 함수 몇 개만 읽어도 개념 파악 쉬워진다

 

 

가로 형식 맞추기

짧은 행이 바람직하다

100자 ~ 120자 정도가 적당

 

 

가로 공백과 밀집도

 

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

 

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

할당 연산자를 강조하려고 앞 뒤에 공백 부여

할당문은 왼쪽 요소와 오른쪽 요소가 분명하게 나뉜다

 

반면 함수 이름과 이어지는 괄호 사이에는 공백 X

함수와 인수는 서로 밀접한 관계를 가지기 때문

 

 

연산자 우선순위 강조를 위한 공백을 사용하기도 한다

 

public double root(double a, double b, double c){
	return (-b + Math.sqrt(determinant(a, b, c)) / (2*a));
}

곱셈은 우선순위가 가장 높기 때문에 공백을 주지 않는다

덧셈, 뺄셈은 우선순위가 곱셈보다 낮기 때문에 공백으로 표현한다

 

 

가로 정렬

 

어셈블리처럼 가로정렬 할 필요 없다

 

 

들여쓰기

 

소스파일은 윤곽도 (outline) 과 계층이 비슷

파일 전체에 적용되는 정보

파일 내 개별 클래스에 적용되는 정보

클래스 내 각 메서드에 적용되는 정보

블록 내 블록에 재귀적으로 적용되는 정보

등이 있다

 

계층에서 각 수준은 이름을 선언하는 범위이자 선언문, 실행문을 해석하는 범위이다

범위(scope) 로 이루어진 계층을 표현할 때 들여쓰기를 사용

 

 

가짜 범위

 

빈 while 문이나 for 문의 세미콜론은 행을 분리하라

 

while (dis.read(buf, 0, readBufferSize) != -1)
;

 

 

 

팀 규칙

프로그래머가 팀에 속한다면 개인 규칙보다 우선 팀 규칙을 따라야 한다

그래야 코드가 일관적인 스타일을 보인다