로버트 C. 마틴의 클린코드 정리 _ 5장 (형식 맞추기)

코드를 딱 열었을 때

• 코드가 깔끔하고 일관적이며
• 꼼꼼하다고 감탄하며
• 질서정연하다고 탄복하며
• 모듈을 읽으며 두눈이 휘둥그래지는
• 전문가가 잤다는 인상을 심어주는

코드가 되었으면 좋겠다.

 

코드가 술에 취해 짜놓은 듯 어수선해 보인다면 프로젝트의 다른 측면도 똑같이 무성의한 태도로 처리했을거라 생각할 것이다.

 

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

• 코드 형식을 맞추기 위해 간단한 규칙을 정하고 그 규칙을 따라야 한다.
• 팀이라면 팀이 합의하여 규칙을 정하고 그 규칙을 모두가 따라야 한다.
• 규칙을 자동으로 적용하는 도구도 활용한다.
• 코드 형식은 중요하다.

적절한 행 길이를 유지하라 (세로 형식 맞추기)

대부분의 자바 소스 파일의 크기는 어느 정도일까?

• JUnit, FitNesses, Time and Money 프로젝트들의 파일은 대부분 200줄 미만이다. 반면 Tomcat, Ant는 절반 이상이 200줄을 넘고 수천 줄이 넘어가는 파일도 존재한다.
• 대부분 200줄 정도인 파일들로도 커다란 시스템을 구축할 수 있음을 알 수 있다.

신문 기사처럼 작성하라

신문 기사를 떠올려보자.

• 독자는 위에서 아래로 기사를 읽는다.
• 최상단에 기사를 몇 마디로 요약하는 표제가 나온다.
• 독자는 표제를 보고 기사를 읽을지 말지 결정할 수 있다.
• 첫 문단은 전체 기사 내용을 요약한다.
• 세세한 사실은 숨기고 커다란 그림을 보여준다.
• 쭉 읽어 내려가면 세세한 사실이 조금씩 드러난다.

소스파일도 같다.

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

개념은 빈 행으로 분리하라

• 거의 모든 코드는 왼쪽에서 오른쪽으로, 위에서 아래로 읽는다.
• 각 행은 수식이나 절을 나타낸다.
• 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다.

빈 행은 새로운 개념이 시작한다는 시각적 단서이다.

세로 밀집도

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

따라서, 서로 밀접한 코드 행은 세로로 가까이 놓아야 한다는 의미이다.

예제 코드

class ReporterConfig {
    /**
     * 리포터 리스너의 클래스 이름
     */
    private lateinit var m_className: String

    /**
     * 리포터 리스너의 속성
     */
    private val m_properties: ArrayList<Property> = arrayListOf()

    fun addProperty(property: Property) {
        m_properties.add(property)
    }
}
-----
class ReporterConfig {
    private var m_className: String = ""
    private val m_properties: ArrayList<Property> = arrayListOf()

    fun addProperty(property: Property) {
        m_properties.add(property)
    }
}

위 코드에서 첫번째 경우는 의미없는 주석으로 두 인스턴스 변수를 떨어뜨려 놓았다.
하지만 두번째 경우 모아둠으로써 코드가 "한눈"에 들어온다. 적어도 (로버트 C. 마틴)에게는 그렇다.

수직 거리

함수나 변수가 정의된 코드를 찾으려 상속관계를 줄줄이 거슬러 올라가는 경험은 좋지 않다.

조각 조각들이 어디에 있는지 찾고 기억하느라 시간과 노력을 쏟게 되는 것은 지양하자.

• 서로 밀접한 개념은 세로로 가까이 둔다.
• 서로 밀접한 개념은 한 파일에 속해야 마땅하다.
  • protected 변수의 사용을 지양해야하는 이유 중 하나다. (상속받은 객체에서 접근하여 사용할 수 있으므로)

변수선언

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

인스턴스 변수

인스턴스 변수는 클래스 맨 처음에 선언한다. 이때 변수 간에 세로로 거리를 두지 않는다.

잘 설계한 클래스는 클래스의 많은 메서드가 인스턴스 변수를 사용한다.

위냐 아래냐 언어마다 논쟁이 있지만 결국 중요한 것은 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이다.

종속 함수

한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 가능하다면 호출하는 함수를 호출되는 함수보다 먼저(위에) 배치한다.

이렇게 하므로서 프로그램이 자연스럽게 읽힌다.

개념적 유사성

친화도가 높은 코드를 가까이 배치한다.

친화도가 높은 요인으로는 여러가지가 존재한다.

• 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성
• 변수와 그 변수를 사용하는 함수
• 비슷한 동작을 수행하는 일군의 함수들

예제 코드

@Internal
public class Assert {
    public static void assertTrue(boolean condition, Supplier<String> msg) {
        if (condition) {
            return;
        }
        throw new AssertException(msg.get());
    }

    public static void assertTrue(boolean condition) {
        if (condition) {
            return;
        }
        throw new AssertException("condition expected to be true");
    }

    public static void assertFalse(boolean condition, Supplier<String> msg) {
        if (!condition) {
            return;
        }
        throw new AssertException(msg.get());
    }

    public static void assertFalse(boolean condition) {
        if (!condition) {
            return;
        }
        throw new AssertException("condition expected to be false");
    }
}

위 처럼 명명법이 똑같고 기본 기능이 유사한 함수들은 개념적인 친화도가 매우 높다. 서로가 서로를 호출하는 종속적인 관계가 없더라도 가까이 배치해야할 함수들이다.

세로 순서

함수 호출 종속성은 아래방향으로 유지한다.

호출되는 함수를 호출하는 함수보다 나중에 배치한다. 이를 통해 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 진행된다.

---

가로 형식 맞추기

가로는 길이는 어느정도가 적당할까?

• 프로젝트를 조사한 결과 20자 ~ 60자 사이인 행이 총 행수의 40%에 달한다. 10자 미만은 30% 정도이다. 80자 이상 부터는 급격히 감소한다.

프로그래머들은 명백하게 짧은 행을 선호하며, 짧은 행이 바람직하다.

 

80자를 강제로 제한하는 것은 다소 인위적이며 100~120자까지는 나쁘지 않다. 하지만 그 이상은 솔직히 프로그래머의 주의부족이다.

가로 공백과 밀집도

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

 

예제 코드

fun measureLine(line: String) {
	linecount++
	val lineSize = line.length
	totalChars += lineSize
	lineWidthHistogram.addLIine(lineSize, lineCount)
	...
}

 

• 할당 연산자를 강조하기 위해 " = " 처럼 연산자 앞뒤에 공백을 줬다. 공백을 넣으므로써 두가지 요소가 확실히 나뉜다는 사실이 분명해진다.
• 함수이름과 이어지는 소괄호 사이에는 공백을 넣지 않았다. 함수와 인수는 서로 밀접하기 때문이다.
• 공백을 넣으면 한 개념이 아니라 별개로 보이게 된다.
• 함수를 호출하는 인수는 쉼표 후 공백으로 분리했다. 쉼표를 강조하여 인수가 별개라는 사실을 보여준다.

val ret = b*b - 4*a*c

• 사칙 연산에서도 연산자 우선순위에 따라 공백을 조절할 수 있지만 IDE가 대부분 연산자 우선순위는 고려하지 못하므로 수식에 똑같은 공백이 적용된다.

가로 정렬

가로 정렬은 유용하지 못하다.

class GaroAlign {
	private val hi				: String
	private val helloWorld		: String
	private val age				: Int
	private val zipCode			: Int
	private val phoneNumber		: Int
	private val birth			: LocalDateTime
}

• 가로 정렬 시 변수 유형은 무시하고 변수 이름부터 읽게 된다.
• IDE에서도 가로 정렬은 무시한다.
• 가로정렬이 필요해 보일정도 목록이 길다면 문제는 목록의 길이이지, 정렬 부족이 아니다.

선언부가 길다면 클래스를 쪼개야 한다는 의미이다!

들여쓰기

소스파일의 계층은 윤곽도와 비슷하다.

• 파일 전체에 적용되는 정보
• 파일 내 개별 클래스에 적용되는 정보
• 클래스 내 각 메소드에 적용되는 정보
• 블록 내 블록에 재귀적으로 적용되는 정보

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

이렇듯 범위로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다.

 

들여쓰기가 없다면 코드를 읽기란 거의 불가능하다.

들여쓰기 무시하기

아래처럼 간단한 if, while 구문에서 들여쓰기를 무시하고 싶은 경우가 존재한다.

이럴때마다 원점으로 돌아가 들여쓰기를 넣는다 !

fun render(): String { return "" }
---
fun render(): String { 
	return "" 
}

 

참고) 코틀린에서는 아래와 같은 표현식 함수(Single-expression functions)가 많이 사용되긴 한다. 따라서, 너무 얽매일 필요는 없어 보인다.

fun render(): String = ""

가짜 범위

빈 while 문.

while 문 끝에 세미콜론 하나를 덧붙인 코드로 인해 골탕먹은 적이 많다. (반복문인줄 알고 아래를 열심히 본다거나?) 따라서, 세미콜론은 새행에다가 제대로 들여써서 넣어준다. 이렇게 하지 않으면 눈에 잘 띄지 않는다.

fun test() {
    val dis = BufferedInputStream(System.`in`)
    val buf = ByteArray(10)
    val len = 10
    while (dis.read(buf, 0, len) != -1)
        ;
}

팀 규칙

프로그래머는 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야할 규칙은 팀 규칙이다.

• 팀은 한가지 규칙에 합의해야한다.
• 모든 팀원은 그 규칙에 따라야 한다.

이렇게 하므로서 소프트웨어는 일관적인 스타일을 보인다. 개개인이 맘대로 짜내는 코드는 피해야 한다!

 

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다. 스타일은 일관적이고 매끄러워야 하며, 한 소스파일에서 본 형식이 다른 소스 파일에서도 쓰이리라는 신뢰감을 줘야 한다.