5장. 형식 맞추기

• 형식을 맞춘 코드를 작성하자. 간단한 규칙을 정하고 규칙을 착실히 따르도록 하자.
• 팀 단위라면 팀이 합의해 규칙을 정하고 모두가 따라야 한다.

형식을 맞추는 목적

• 코드 형식은 소통의 일환이다. 그리고 소통은 개발자의 일차적인 의무다.
• 오늘 구현한 기능은 다음 버전에서 높은 확률로 변경된다. 그러나 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드 품질에 지대한 영향을 미친다.
• 코드는 바뀌기 마련이다. 기존 기능이 수정 / 삭제되기도 하고, 새로운 기능이 추가되기도 한다. 그러나 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 변하지 않는다. 작성한 코드의 유지보수 용이성과 확장성에 계속해서 영향을 미친다.

적절한 행 길이를 유지하라.

• 어떤 거대한 프로젝트도 대부분 200줄 정도의 파일들로 구성할 수 있다.
• 특정 파일이 커질 수는 있다. 그러나 500줄 이내 정도를 유지하자.
• 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

- 신문 기사처럼 작성하라

• 소스 파일은 신문 기사처럼 작성하자.
  • 이름은 간단하면서도 설명 가능하게 짓자.
  • 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명하자.
  • 아래로 내려갈수록 의도를 세세하게 묘사하자.
  • 마지막에는 가장 저차원 함수와 세부 내역이 나오게 하자.
• 신문을 읽을 때, 한 면을 가득 채우는 기사를 본 적이 있는가? 그런 기사는 있지도 않을 뿐더러 있다 한들 방대한 양에 읽기 싫어질 것이다. 소스 코드도 마찬가지다.

- 개념은 빈 행으로 구분하라

• 생각 사이에는 빈 행을 넣어 분리해야 마땅하다.
• 패키지 선언, import, 각 함수 간에 넣는 빈 행은 각 부분을 명확하게 구분해주고 서로 다름을 표시해준다.

- 세로 밀집도

• 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓아야 한다.
• 클래스의 인스턴스 변수는 빈 행 없이 붙여 놓는다. 인스턴수 변수들의 작성이 끝나면 빈 행을 넣어 한 줄을 띄우고 메서드들을 작성한다. 둘이 확실하게 분리 된다.

- 수직 거리

• 서로 밀접한 개념은 세로로 가까이에 두자.
• protected 변수의 사용은 피하자. protected 변수는 상속 클래스에 한해, 다른 패키지에서도 사용할 수 있다. 서로 밀접한 개념은 한 파일에 존재해야 한다는 규칙을 어기는 로직이 스며들 수 있다.
• 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
• 변수 선언
  • 변수는 사용하는 위치에 최대한 가까이 선언한다.
  • 지역 변수는 각 함수 맨 처음에 선언한다.
  • 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.
• 인스턴스 변수
  • 인스턴스 변수는 클래스 맨 처음에 선언한다.
• 종속 함수
  • 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
  • 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
• 개념적 유사성
  • 친화도가 높을수록 코드를 가까이 배치한다.
  • 한 함수가 다른 함수를 호출해 직접적인 종속성이 생길 때, 변수를 선언하고 사용할 때, 여러 함수들이 비슷한 동작을 수행할 때 등의 상황이 개념적 유사성이 높은 상황이라고 할 수 있다.

- 세로 순서

• 일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 즉, 호출하는 함수를 먼저 배치하고 호출되는 함수를 나중에 배치한다.
• 가장 중요한 개념을 가장 먼저 표현한다. 세세한 사항은 가장 마지막에 표현한다.

가로 형식 맞추기

• 한 행은 가급적 짧은 편이 좋다. 그렇다고 지나치게 제한하지는 말자. 120자 정도로 제한하면 충분하다.

- 가로 공백과 밀집도

• 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
• 예를 들어, 할당 연산자를 강조하기 위해서는 앞뒤에 공백을 줄 수 있다. 공백을 넣으면 두 주요 요소가 확실히 나뉜다는 사실이 분명해진다.
• 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다. 함수와 인수는 밀접하기 때문이다.

 int radius = 3;
 double area = calculateArea(raidus);

• 수식의 경우, 연산자 우선순위를 강조하기 위해 일부러 공백을 없앨 수도 있다. 예를 들어, 곱하기는 더하기보다 먼저 계산되기 때문에 a*a + b; 와 같은 형태로 표현할 수 있는 것이다.
  • 그러나 IDE에서 자동 정렬을 사용하면 보통 모든 연산자와 값을 떨어트려 놓는다. 고의적으로 줄여놓는 과정이 필요할 수 있다.

- 가로 정렬

• 모든 코드의 가로 공백을 억지로 맞추지 말자. 오히려 가독성을 떨어뜨린다.

private String name;
private int    age;

 

- 들여 쓰기

• 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.
• 클래스 선언은 들여쓸 필요없다. 클래스의 멤버인 인스턴스 변수, 메서드들은 하나 들여쓴다. 메서드의 구현은 그보다 하나 더 들여쓴다.
• 개발자는 들여쓰기에 의존해 코드를 시각적으로 받아들인다. 들여쓰기 규칙을 잘 지키는 것은 중요하다.

팀 규칙

• 자신이 정한 어떤 규칙도 팀이 정한 규칙보다 중요하지 않다. 팀에서 협의해서 정의한 규칙은 반드시 따르자.