5장. 형식 맞추기

형식을 맞추는 목적

코드의 형식은 중요하다.

맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. 원래 코드는 사라지더라도 개발자의 스타일과 규율은 사라지지 않는다.

오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

적절한 행 길이를 유지하라

대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.

엄격히 지켜야 할 규칙은 아니지만, 바람직한 규칙으로 삼으면 좋다. 일반적으로 작은 파일이 큰 파일보다 이해하기 쉽기 때문

신문 기사처럼 작성하라

이름은 간단하면서도 설명이 가능하게 지어야 하는데, 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 지어라.

그리고 아래로 내려갈수록 의도를 세세하게 묘사하라. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

신문은 다양한 기사로 이뤄지며, 일부 기사는 조금 길기도 하지만 대다수의 기사가 짧게 구성되어 있음을 기억하자!

개념은 빈 행으로 분리하라

일련의 행 묶음은 완결된 생각 하나를 표현한다.

생각 사이에는 빈 행을 넣어 분리해야 마땅하다. 빈 행은 새로운 개념을 시작한다는 시각적 단서.

세로 밀집도

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

즉, 세로 밀집도는 연관성을 의미한다.

수직 거리

함수 연관 관계와 동작 방식을 이해하기 위해 이 함수에서 저 함수로 오가며 소스 파일을 뒤지게 되면 어떤 소스가 어디 있는지 찾고 기억하느라 시간과 노력을 소모하게 됨

따라서 서로 밀접한 개념은 세로로 가까이 두기! 그러나 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않음

-> 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속하도록 하자. -> protected 변수를 피해야 하는 이유 중 하나.

protected 변수를 피해야 하는 이유

왜 protected 변수를 피해야 하는지 조금 고민을 해봤는데, 저자가 얘기하려는 의도를 생각했을 때 나는 다음과 같이 이해를 하였다.

• protected 접근 지시자를 사용하는 이유는 하위 클래스(동일 패키지 or 다른 패키지 상속받은 클래스)에서 접근이 가능하기 위함.

• 이는 결국 밀접한 개념을 한 파일에 넣지 않고 다른 파일로 분리시키는 것과 다름없기 때문에 좋지 않은 설계가 됨

그래서 저자는 밀접한 개념은 한 파일로 모으는 것이 좋다고 생각하기 때문에 protected 변수를 피해야 한다고 주장하는 것 같다.

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

연관성 : 한 개념을 이해하는 데 다른 개념이 중요한 정도.

연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.

변수 선언

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

• 지역 변수 : 각 함수 맨 처음에 선언.

• 루프 제어 변수 : 루프 문 내부에 선언. 다소 긴 함수에서 블록 상단이나 루프 직전에 변수를 선언하기도 함.

• 인스턴스 변수 : 클래스 맨 처음에 선언. 변수 간 세로로 거리를 두지 않는다. 잘 알려진 위치에 인스턴스 변수를 모으자.

• 종속 함수 : 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치. 또한 호출하는 함수를 호출되는 함수보다 먼저 배치하자. -> 자연스럽게 읽힘

  • 상수를 알아야 하는 함수에서 실제로 사용하는 함수로 상수를 넘겨주는 방법이 좋음

  • 그렇지 않으면 잘 알려진 상수가 적절하지 않은 저차원 함수에 묻혀 버림.

• 개념적 유사성 : 친화도가 높을수록 코드를 가까이 배치하라.

  친화도가 높은 요인

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

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

  static public void assertFalse(boolean condition) { assertFalse(null, condition); }

   이런 경우는 종속적인 관계가 없더라도 가까이 배치하면 좋다.

세로 순서

호출되는 함수를 호출하는 함수보다 나중에 배치하여 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려가도록 하자.

가장 중요한 개념을 표현할 때는 세세한 사항을 최대한 배제하고, 세세한 사항은 가장 마지막에 표현한다.

가로 형식 맞추기

짧은 행이 바람직하다.

저자는 120자 정도로 행 길이를 제한하는 것을 권장한다고 한다.

(지금 프로젝트에서는 몇 으로 lint 값을 설정해두었는지 궁금해서 찾아봤는데, 120 자로 맞춰져있었다!)

가로 공백과 밀집도

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

• 할당 연산자 : 공백을 넣어 두 가지 요소가 확실히 나뉜다는 사실을 강조

• 함수 이름과 이어지는 괄호 : 함수와 인수는 서로 밀접하기 때문에 공백을 넣지 않음.

• 함수 호출 시 괄호 안 인수 : 공백을 넣어 쉼표를 강조해 인수가 별개라는 사실 강조

• 연산자 우선순위 : 공백을 넣어 강조

• 승수 사이에는 공백을 넣지 않는다. (곱셈이 우선순위가 가장 높아서)

• 항 사이에는 공백을 넣는다.

가로 정렬

저자는 특정 구조를 강조하고자 변수 이름과 피연산자를 나란히 정렬했었음.

하지만 이렇게되면 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지게 된다. -> 변수 유형을 무시하고 변수 이름부터 보게 되고, 할당 연산자 보다는 피연산자 먼저 보게 됨

정렬하지 않으면 오히려 중대한 결함을 찾기 쉬워지고, 정렬이 필요한 상황이라면 목록의 길이가 문제이므로 클래스를 쪼개는 것이 바람직함

들여 쓰기

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

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

이렇게 범위로 이뤄진 계층을 표현하기 위해 들여쓰기를 한다.

가짜 범위

빈 while 문이나 for 문은 웬만하면 피하는 것이 좋다.

public String render() throws Exception {return ""; }

예전에 C++ 를 사용하여 알고리즘 문제를 풀 때 이런 식으로 많이 짰던 거 같은데, 지금 보니 굳이 사용할 필요가 없을 듯 하다.

팀 규칙

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

팀 규칙을 잘 지키면 소프트웨어가 일관적인 스타일을 가질 수 있다.

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄지며, 일관적이고 매끄러운 스타일을 가진다.

정리

• 이름 잘 짓기.

• 클래스 내에 인스턴스 변수들은 위 (혹은 아래) 에 한 곳으로 모으기

• 메소드는 호출하는 메서드가 호출되는 메서드보다 위 쪽으로. 자연스럽게 다음 메서드를 읽어 내려갈 수 있도록

느낀점

이번 챕터에서는 마지막에 정리한 내용이 나한테 좀 와닿았던 내용들이다. 다른 내용들은 사실 당연하다고 생각하기 때문에 "이런 게 있네~" 정도로 생각하며 넘어갔다.

정리한 내용들은 코드를 작성할 때 유의를 해서 작성하면 좋을 거 같다.