Nzzi

클린 코드 - 5장 형식 맞추기

15 Jul 2021
Java, CleanCode, books


Intro



초서-독서 한 내용을 그대로 적는 곳이기 때문에 책을 읽지 않은 분들이 보기에 맥락이 애매할 수 있습니다.

초서 : 책을 읽는데 그치는 것이 아닌 손을 이용해 책의 중요한 내용을 옮겨 적음으로써 능동적으로 책의 내용을 수용하고 판단하여 새로운 지식을 재창조하는 과정. 메타인지 학습법




Index





5장 형식 맞추기


프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.

코드 컨벤션과 같은 코드 스타일 가이드는 코드의 가독성을 증가시키고 일관된 코드 스타일을 유지할 수 있게 도와준다.


형식을 맞추는 목적

코드 형식은 의사소통의 일환이다.

오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도
맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미치게 된다.
원할한 소통을 장려하는 코드 형식에 대해 알아보자.


적절한 행(세로) 길이 유지

자바에서 파일크기는 클래스 크기와 밀접하다.
일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.


신문 기사 처럼 작성하라

소스 파일도 신문 기사와 비슷하게 작성한다.

  • 이름은 간단하면서도 설명이 가능하게 짓는다.
  • 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
  • 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
  • 아래로 내려갈수록 의도를 세세하게 묘사한다.
  • 마지막에는 가장 저차원 함수와 세부 내역이 나온다.


개념은 빈 행으로 분리하라

일련의 행 묶음은 완결된 생각 하나를 표현한다.
생각 사이에는 빈 행을 넣어 분리해야 마땅하다.
빈 행은 새로운 개념을 시작한다는 시각적 단서이다.

public class Example {
    public void exampleMethod1(Argument argument1, Argument argument2) { 
        doSomething1(argument1); doSomething2(argument2); ...} 
    public void exampleMethod2(Argument argument1, Argument argument2) { 
        doSomething1(argument1); doSomething2(argument2);
        ...}
    public void exampleMethod3(Argument argument1, Argument argument2) { 
        doSomething1(argument1); doSomething2(argument2);
        ...
    }
}

위 코드 보다는 아래 코드가 가독성이 좋다.

public class Example {
    
    public void exampleMethod1(Argument argument1, Argument argument2) { 
        doSomething1(argument1); 
        doSomething2(argument2); 
        ...
    } 
    
    public void exampleMethod2(Argument argument1, Argument argument2) { 
        doSomething1(argument1);
        doSomething2(argument2);
        ...
    }
    
    public void exampleMethod3(Argument argument1, Argument argument2) { 
        doSomething1(argument1);
        doSomething2(argument2);
        ...
    }
}


세로 밀집도

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

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);
    }
}


수직 거리

함수 연관 관계와 동작 방식을 이해하려고 이 함수에서 저 함수로 오가며 소스 파일을 위아래로 뒤지는 뺑뺑이를 돈 경험이 있는가?
이 조각 저 조각이 어디에 있는지 찾고 기억하느라 시간과 노력을 소모한다.


연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.
연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.


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

  • 인스턴스 변수
    인스턴스 변수는 클래스 맨 처음에 선언한다.
    변수 간에 세로로 거리를 두지 않는다.
    잘 설계한 클래스는 많은 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.

  • 종속 함수
    한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
    또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.

  • 개념적 유사성
    어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다.
    비슷한 동작을 수행하는 일군의 함수가 좋은 예다.


세로 순서

호출되는 함수를 회출하는 함수보다 나중에 배치한다.
그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.


신문 기사와 마찬가지로 가장 중요한 개념을 가장 먼저 표현한다.
그러면 독자가 소스 파일에서 첫 함수 몇 개만 읽어도 개념을 파악하기 쉬워진다.


가로 형식 맞추기

가로 공백과 밀집도

가로로는 공백(띄어쓰기)을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
공백을 넣으면 한 개념이 아니라 별개로 보인다.
연산자 우선순위를 강조하기 위해서도 공백을 사용한다.

private static double determinant(double a, double b, double c) {
    return b*b - 4*a*c;
}


들여쓰기

범위로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.
들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.


떄로는 if 문, 짧은 while 문, 짧은 함수에서 들여쓰기 규칙을 무시하고픈 유혹이 생긴다.
하지만 한 행에 범위를 뭉뚱그린 코드를 피해야 한다.

public class CommentWidget extends TextWidget {
    public CommentWidget(ParentWidget parent, String text) {super(parent,text);}
    public String render() throws Exception {return "";}
}

public class CommentWidget extends TextWidget {
    
    public CommentWidget(ParentWidget parent, String text) {
        super(parent, text);
    }
    
    public String render() throws Exception {
        return "";
    }
}


가짜 범위

세미콜론(;)은 새 행에다 제대로 들려써서 넣어준다.
그렇게 하지 않으면 눈에 띄지 않는다.

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


팀 규칙

팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다.
그래야 소프트웨어가 일관적인 스타일을 보인다.


좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억해야 한다.
스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.



Related Posts